Skip to main content
PUT
Update a folder

Authorizations

X-API-Key
string
header
required

API key (sk_xxx) from Developer Settings. No X-Account-ID needed.

Headers

x-account-id
string | null

Path Parameters

folder_id
string<uuid>
required

Body

application/json

Schema for updating an existing favorite folder.

name
string | null
Required string length: 1 - 255
parent_id
string<uuid> | null
display_order
integer | null
is_hidden
boolean | null
color
string | null
Maximum string length: 50

Response

Successful Response

Response schema for favorite folder API endpoints.

name
string
required

Folder name

Required string length: 1 - 255
id
string<uuid>
required
account_id
string<uuid>
required
user_id
string<uuid>
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
parent_id
string<uuid> | null

Parent folder ID for nested folders

display_order
integer | null

Display order

is_hidden
boolean
default:false

Whether folder is hidden from sidebar

color
string | null

Optional color for folder

Maximum string length: 50
children_count
integer | null

Number of child folders

favorites_count
integer | null

Number of favorites in folder