Save a status. Creates a status when id is omitted (name and type required), or updates the status with that id. type drives reports and the roadmap: open, active, complete or closed. is_default: true makes it the status new posts get (the previous default stops being one). Names are unique, ignoring case. See current statuses in get_workspace_overview. Nobody is emailed. Managers and owners.
Toolset
admin
Who can call it
OwnersManagersAPI keys
REST
POST /api/v1/w/{workspace}/statuses
Behavior
changes dataaccepts idempotency_key
Input
Field
Type
Description
id
string
Omit to create a status; pass to update it.
name
string
Required to create.
color
string
Defaults to a color for the type.
type
one of: open, active, complete, closed
Required to create.
show_on_public_roadmap
boolean
Default false.
is_default
boolean
position
integer
Where to place it, from 0 (first). Others shift. Omit to keep it.
expected_version
integer
The status's version from get_workspace_overview. If it changed since, the call fails instead of overwriting a newer change.
idempotency_key
string
Retry-safe key. Repeating a call with the same key returns the first result.
Output
Field
Type
Description
idrequired
string
ID with prefix "sts_"
workspace_idrequired
string
ID with prefix "ws_"
namerequired
string
colorrequired
string
typerequired
one of: open, active, complete, closed
open: new or unreviewed. active: accepted or in progress. complete: shipped. closed: won't do.
positionrequired
integer
show_on_public_roadmaprequired
boolean
is_defaultrequired
boolean
New posts get this status. Exactly one status is default.