Skip to main content
PATCH
Rename / move a folder

Authorizations

x-api-key
string
header
required

Org-issued integration API key (service account credential). The plaintext secret is shown once at creation.

Headers

X-Idempotency-Key
string
required

Stable caller-chosen key (max 200 chars) making the mutation safely retryable.

Maximum string length: 200
If-Match
string
required

Current entity revision, quoted (e.g. "3"), from the last ETag.

Path Parameters

folderId
string
required

Folder id

Query Parameters

organizationId
string<uuid>

Select one organization for this request. Defaults to the key organization. An HQ key may select an active descendant when its active acting attorney has the required HQ and resource permissions. Repeat the same organizationId on related mutations, upload completion, detail requests, and every cursor page. See /authorization.

Body

application/json
name
string
Required string length: 1 - 255
parentFolderId
string | null
Required string length: 1 - 200

Response

{ success: true, folder } + ETag

success
boolean
required
{key}
any