Skip to main content
POST
Create a workflow status

Authorizations

Authorization
string
header
default:dav_ak_live_your_token
required

Personal access token. The scopes granted at issuance determine both which operations the key may call and the ceiling on the resource permissions it can exercise. Each scope family is a ladder: projects:manage implies projects:write and projects:read; cards:manage implies cards:write and cards:read; and teams:manage implies teams:write and teams:read. These are named API capability bundles, not blanket domain roles: manage exposes only the permissions enumerated for that scope and never bypasses the acting user's current role-based access.

Headers

Idempotency-Key
string

A value you choose to identify this request, so that retrying it does not repeat its effect. Reuse the same key when retrying and the original result is returned; use a fresh key when you mean to create something new. Keys are scoped to the API key that sent them (or to the user for browser sessions). Replayed responses include Idempotency-Replayed: true.

Maximum string length: 255

Path Parameters

orgId
string<uuid>
required

Organization id.

teamId
string<uuid>
required

Agile team id.

Body

application/json
name
string
required

Sanitized by the server to a resource name of at most 255 characters.

description
string | null
color
string
default:#000000
position
string
transitionState
enum<string>
default:not_started
Available options:
not_started,
started,
closed
closeMode
enum<string>
default:off

Automatic close-on-entry behavior for a workflow status. The bulk close action is available for every status. off leaves card state unchanged on entry, while automatic closes open cards on entry. manual is a deprecated legacy value with the same entry behavior as off. add_mover_to_assignees is a deprecated write alias that stores closeMode=off with assignMoverOnEntry=true; reads never return that alias.

Available options:
off,
manual,
automatic,
add_mover_to_assignees
assignMoverOnEntry
boolean
default:false
requiredCardFields
enum<string>[]

User-editable scalar card field that a workflow status may require.

Available options:
name,
description,
resolution,
deadline,
effort

Response

Workflow status created.

status
object
required