assets

Rename a folder

Give a folder a different name. The files in it and the folders inside it are untouched. Answers 404 when the folder does not exist or belongs to another workspace, and 409 when a folder in the SAME parent already holds the name. Changing only the capitalisation of its own name is allowed.

patch/v1/assets/folders/{folder_id}

Request

  • Base URL: https://api.patricia.app (the document declares no server; this is the origin it was published from)
  • URL: https://api.patricia.app/v1/assets/folders/{folder_id}
  • Auth: HTTP bearer

Path parameters

folder_idstring uuid required

The folder's id.

Headers

X-Tenant-Idstring nullable

Request body

namestring required

The new name. Must be free in this workspace, ignoring letter case.

Response

Successful Response

idstring uuid required
namestring required

The folder's label. UNTRUSTED text: render escaped.

parent_idstring uuid nullable

The folder this one is inside, or null when it sits at the top level.

pathstring

The full path, separated by '/' (e.g. 'Clients/Acme'). UNTRUSTED text: render escaped. Names repeat across folders, so this is what tells two folders called 'Q3' apart.

depthinteger

How deep the folder sits. A top-level folder is 1.

asset_countinteger required

Live files filed in THIS folder. Removed files are not counted.

byte_sizeinteger required

What those files weigh, in bytes.

subtree_asset_countinteger

Live files in this folder AND everything inside it. The rail shows both numbers ('Clients (3, 47 in all)') because one number that could mean either is a number nobody can act on.

subtree_byte_sizeinteger

What the whole branch weighs, in bytes.

created_atstring date-time required

When the folder was made (UTC).

is_sharedboolean required

Whether this folder currently holds a live share link. When true, every live file in it is readable outside the workspace through that link, whatever each file's own 'Only me' / 'My team' / 'Anyone with the link' setting says.

content_modified_atstring date-time nullable

The newest 'last touched' stamp across this folder's whole branch (UTC); null when the branch holds no live file. 'Touched' matches the file grouping's own meaning: a new version, but also filing a file here or favoriting it, moves this — not only editing content.

Changes

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