authed

Update Folder

Rename a folder or change its icon; placement is move_folder's job.

patch/api/v1/folders/{folder_id}

Request

  • Base URL
    https://api.teaflask.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.teaflask.com/api/v1/folders/{folder_id}
  • Auth
    none declared

Path parameters

folder_idstring uuid required

Request body

namestring required
iconstring nullable required

Response

Successful Response

idstring uuid required

The folder's id.

organization_idstring uuid required

The organization the folder belongs to.

parent_idstring uuid nullable required

The folder it sits inside; null for a top-level folder.

positioninteger required

Its place among the folders that share its parent, from 0.

namestring required

The folder's name.

iconstring nullable required

The folder's icon; null when it has none.

created_atstring date-time required

When the folder was created.

updated_atstring date-time required

When the folder last changed.

Changes

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