REST API Reference

Back Next

Updating a folder

You can change a folder's name or description if you have update permission for the folder.

PATCH request

To update a folder that's in the Default project, send a PATCH request using the following URI:

/public/core/v3/folders/<folder ID>

To update a folder that's in a project other than the Default project, use one of the following URIs:

/public/core/v3/projects/<project ID>/folders/<folder ID>

/public/core/v3/projects/name/<project name>/folders/name/<folder name>

You can include project and folder IDs or project and folder names in a URI, but you can't include an ID and a name in a URI. For example, you can't include the project ID and the folder name.

Include the following information:

Field	Type	Required	Description
name	String	-	Name of the folder.
description	String	-	Description of the folder.

PATCH response

Returns a success code if successful or an error object if errors occur.

PATCH example

To change the name and description of the Northeast Orders folder, you might send a request similar to the following example:

PATCH <baseApiUrl>/public/core/v3/projects/name/Orders/folders/name/Northeast%20Orders
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <sessionId>
{
    "name":"Northeast Requests",
    "description": "Requests from the northeast offices"  
}

Rename Saved Search

Table of Contents

REST API Reference

REST API Reference

Updating a folder

Updating a folder

PATCH request

PATCH response

PATCH example