Skip to main content
PATCH
/
api
/
v1
/
statuses
/
{id}
Update status
curl --request PATCH \
  --url https://api.getarca.app/api/v1/statuses/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "category": "<string>",
  "icon": "<string>",
  "color": "<string>",
  "position": 123
}
'
{
  "id": 4,
  "workspace_id": 3,
  "name": "In Review",
  "icon": "review",
  "color": "orange",
  "category": "in_progress",
  "position": 3,
  "created_at": "2026-04-11T10:30:00.000Z"
}
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

​
id
string
required
The numeric status ID.

​
Request body

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

​
Response

Returns the full updated status object.
​
id
number
required
Status identifier.
​
workspace_id
number
required
Workspace this status belongs to.
​
name
string
required
Status label.
​
icon
string | null
Icon slug.
​
color
string | null
Color value.
​
category
string
required
Status category.
​
position
number
required
Sort position.
​
created_at
string
required
UTC ISO-8601 creation timestamp.
{
  "id": 4,
  "workspace_id": 3,
  "name": "In Review",
  "icon": "review",
  "color": "orange",
  "category": "in_progress",
  "position": 3,
  "created_at": "2026-04-11T10:30:00.000Z"
}