Folder Templates

List folder templates for a workspace

get
Query parameters
workspace_idstring · uuidRequired

The id of the workspace to get folder templates from

drive_idany ofOptional

Optional drive id to filter templates specific to that drive

string · uuidOptional
or
nullOptional
Header parameters
passwordany ofOptional

The password header to use to fetch the preview

stringOptional
or
nullOptional
Body
Responses
chevron-right
200

A list of folder templates

application/json
get
/folder-templates

Create a folder template from an existing folder

post
Header parameters
passwordany ofOptional

The password header to use to fetch the preview

stringOptional
or
nullOptional
Body
namestringRequired

The name of the folder template

descriptionstringOptional

A brief description of how to use this template

Default: ""
iconstringOptional

Icon key used by the client when displaying this template

Default: ""
workspace_idstring · uuidRequired

The id of the workspace this template belongs to (always required)

drive_idany ofOptional

Optional drive id if this template is specific to a drive within the workspace

string · uuidOptional
or
nullOptional
root_pathstring · pathRequired

The absolute path of the folder to capture as a template

Responses
chevron-right
200

The created folder template

application/json
post
/folder-templates

Delete a folder template

delete
Path parameters
template_idstring · uuidRequired

The ID of the folder template to delete

Header parameters
passwordany ofOptional

The password header to use to fetch the preview

stringOptional
or
nullOptional
Body
Responses
chevron-right
200

True if the template was deleted successfully

application/json
Responseboolean
delete
/folder-templates/{template_id}

Update a folder template

patch
Path parameters
template_idstring · uuidRequired

The ID of the folder template to update

Header parameters
passwordany ofOptional

The password header to use to fetch the preview

stringOptional
or
nullOptional
Body
nameany ofOptional

The new name for the folder template

stringOptional
or
nullOptional
descriptionany ofOptional

The new description for the folder template

stringOptional
or
nullOptional
iconany ofOptional

The new icon key for the folder template

stringOptional
or
nullOptional
Responses
chevron-right
200

The updated folder template

application/json
patch
/folder-templates/{template_id}

Last updated