Create a workflow state
Color defaults to "#95a2b3"; position defaults to (max position in the team) + 1. The team must belong to the caller's org (else 404 — org tenancy). `name` is stored trimmed and must be unique within the team, compared case-insensitively — a name already in use is a 409. Two different teams may each use the same name. A `type` outside the enum is a 400 naming the allowed set — the column carries a CHECK constraint, so an unlisted value could never be stored.
View as MarkdownAuthorization
bearer In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/states" \ -H "Content-Type: application/json" \ -d '{ "teamId": "a4ede8ba-7c0a-4485-8763-cbd9b282fbec", "name": "string", "type": "backlog" }'{ "state": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "teamId": "a4ede8ba-7c0a-4485-8763-cbd9b282fbec", "name": "string", "type": "backlog", "color": "string", "position": 0, "description": "string", "canDelete": true }}List workflow states
Workflow states across the org's teams, ordered by position. Filter with team_id (a team outside the org just yields an empty list).
Update a workflow state
Partial update — only provided fields change. A `name` that another state in the same team already uses is a 409; a blank one is a 400. Re-sending the state's own name is always allowed. A `type` outside the enum is a 400 naming the allowed set. Changing `type` away from the team's only state of that category is a 409, same rule DELETE already enforces — re-sending the state's own current type is always allowed, even when it is that only state.