Folders

Update a folder

Updates the specified folder. All fields are optional. To reparent the folder, set parentFolderId to the target folder ID (use "root" for the top level). If a sibling at the target has the same name, the folder is auto-renamed. To move reports or allocations into or out of a folder, update the item's folderId field via the report or allocation PATCH endpoint.

patch/analytics/v1/folders/{id}

Request

  • Base URL
    https://api.doit.com
  • URL
    https://api.doit.com/analytics/v1/folders/{id}
  • Auth
    • API key in header Authorization
    • or API key in header X-Tenant-Id and API key in header Authorization

Path parameters

idstring required

Folder ID.

Request body

namestring

Folder name.

descriptionstring

Folder description.

parentFolderIdstring

Identifier of the new parent folder. Use "root" to move the folder to the top level. If a sibling at the new parent has the same name, the folder is auto-renamed (e.g. "Foo" → "Foo (1)").

Example request

{
  "parentFolderId": "root"
}

Response

OK - Folder updated.

idstring

Folder ID.

namestring

Folder name.

descriptionstring

Folder description.

parentFolderIdstring

Identifier of the parent folder. Set to "root" if the folder is at the top level.

Example response

{
  "parentFolderId": "root"
}

Changes

No recorded changes to this operation across all 1 revision of this API.