POST
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.

Body

application/json
appliesTo
enum<string>
required

Registry that will own this status. Use content for posts or task for tasks.

Available options:
content,
task
name
string
required

a string at most 64 character(s) long

Required string length: 1 - 64
colour
string
required

a string at most 32 character(s) long

Required string length: 1 - 32
category
enum<string>
required

Stable behavior category for this status. Names can change, but category drives workflow rules.

Available options:
not_started,
active,
in_review,
completed,
closed
position
integer

Board column order. Omit to append the status to the end of the board.

Required range: x >= 0
autoPostEligible
boolean

Whether this content status can trigger automatic publishing. Defaults to false.

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