Skip to main content
PATCH
Update status
Requires the workspaces:write scope. Only workspace owners and admins can update statuses.
You cannot change the category of the last remaining completed status in a workspace. At least one completed status must always exist.

Path parameters

string
required
The numeric status ID.

Request body

All fields are optional. Send only the fields you want to update.
string
New status label.
string
New status category. Must be one of pending, in_progress, completed, or cancelled.
string
Icon slug.
string
Color value.
number
Sort position integer. Use this to reorder statuses.

Response

Returns the full updated status object.
number
required
Status identifier.
number
required
Workspace this status belongs to.
string
required
Status label.
string | null
Icon slug.
string | null
Color value.
string
required
Status category.
number
required
Sort position.
string
required
UTC ISO-8601 creation timestamp.