APIDirectories

Update

Update the Directory with the given ID.

Path parameters

idstringRequired

Unique identifier for Directory. Starts with dir_.

Headers

X-API-KEYstringRequired

Request

This endpoint expects an object.
namestringOptional
Name to set for the directory.
parent_idstringOptional

ID of the parent directory. Specify this to move directories. Starts with dir_.

pathstringOptional

Path to move the directory to, relative to the root directory. Specify this to move directories. Includes name, e.g. path/to/directory.

Response

Successful Response
idstring

String ID of directory. Starts with dir_.

namestring
Name of the directory.
pathstring

Path to the directory, relative to the root directory. Includes name, e.g. path/to/directory.

tagslist of strings
List of tags associated with the directory.
created_atdatetime
updated_atdatetime
parent_idstringOptional

ID of the parent directory. Will be None if the directory is the root directory. Starts with dir_.

descriptionstringOptional
Description of the directory.
readmestringOptional
Long description of the directory.

Errors