PATCH
TypeScript client

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

teamId
string
required

Team (workspace) id (UUID). Discover ids via the list teams endpoint or the agent context.

statusId
string
required

Workflow status id from the workspace registry.

Body

application/json
name
string

a string at most 64 character(s) long

Required string length: 1 - 64
colour
string

a string at most 32 character(s) long

Required string length: 1 - 32
position
integer

a non-negative number

Required range: x >= 0
category
enum<string>

New stable behavior category. Omit to keep the current category.

Available options:
not_started,
active,
in_review,
completed,
closed
autoPostEligible
boolean

Whether this content status can trigger automatic publishing. Omit to keep the current value.

Response

Success

id
string<uuid>
required

a Universally Unique Identifier

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
teamId
string<uuid>
required

a Universally Unique Identifier

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
name
string
required
colour
string
required
position
number
required
appliesTo
enum<string>
required
Available options:
content,
task
category
enum<string>
required
Available options:
not_started,
active,
in_review,
completed,
closed
autoPostEligible
boolean
required
isTerminal
boolean
required
createdAt
string
required
updatedAt
string
required