Skip to main content
PATCH
Rename or move a folder

Authorizations

Authorization
string
header
required

Personal Access Token. Send as Authorization: Bearer hq_pat_....

Path Parameters

id
string<uuid>
required

Folder id

Body

application/json
name
string | null

New name.

parent_id
string | null

Reparent within the same scope. null moves to the root; omitted keeps it. Cannot create a cycle.

Response

Updated folder

created_at
string<date-time>
required
doc_count
integer<int64>
required

Live documents directly in this folder.

id
string<uuid>
required
is_owner
boolean
required
name
string
required
owner_user_id
string<uuid>
required
scope
string
required
updated_at
string<date-time>
required
channel_id
string<uuid> | null
channel_name
string | null
parent_id
string<uuid> | null