Skip to main content
PATCH
Update a folder

Authorizations

Authorization
string
header
required

Workspace API key, sent as Authorization: Bearer lk_live_….

Path Parameters

id
string<uuid>
required

Folder ID.

Body

application/json
name
string

Folder name. Links is reserved and rejected with 400.

Maximum string length: 50
Example:

"Paid campaigns"

color
enum<string>

The colour of the folder.

Available options:
red,
orange,
yellow,
green,
teal,
blue,
purple,
pink,
gray
Example:

"orange"

isDefault
boolean

Make this the folder new links land in. Any other default is cleared first.

Response

The updated folder.

id
string<uuid>
name
string
Example:

"Paid campaigns"

color
string | null
Example:

"#f97316"

isDefault
boolean

New links land here when no folderId is sent.

isSystem
boolean

System folders cannot be renamed or deleted.

isActive
boolean
parentId
string<uuid> | null

Present on the model but unused — folders are flat in practice.

workspaceId
string<uuid>
createdById
string<uuid> | null
updatedById
string<uuid> | null
createdAt
string<date-time>
updatedAt
string<date-time>
_count
object

Counts only links that are neither archived nor deleted.