Skip to content
LogoLogo

Update or restore a workflow Status

Update or restore a workflow Status

PATCH/api/v1/statuses/{status_id}

Updates supplied fields. Set archived: false to restore an archived Status.

Path Parameters

status_idRequired
string <uuid>
Example0198ac5e-f9b7-7000-8000-000000000001

Header Parameters

X-CSRF-TokenRequired
string·min 43·max 43

Session-bound CSRF token. It must exactly match the __Host-assign_csrf cookie sent with the request.

If-MatchRequired
string

Entity tag containing the resource version last observed by the client.

Idempotency-KeyRequired
string·min 16·max 200

Opaque client-generated key for safely retrying this operation.

Request Body

application/json
label
string·min 1·max 100
category
string
Values
backlogtodoin_progressin_reviewdone
status_type
string

Canonical lifecycle meaning. Custom labels remain presentation; completed and cancelled are terminal.

Values
backlogunstartedstartedcompletedcancelled
icon
string
color
string
archived
boolean

Only false is accepted to restore an archived Status.

Responses