EaserixDocs
DevelopersAPI referenceTasksStates

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.

View as Markdown
PATCH
/v1/states/{id}

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

id*string
Formatuuid

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 PATCH "https://example.com/v1/states/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'
{  "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  }}

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.

Delete a workflow state

Hard delete, and only when nothing points at the state. Issues carry a NOT NULL state, so a state that still has issues is a 409 naming how many — move them to another state first, then delete it. Also a 409 when this is the last state of its `type` in the team: progress bars, completion %, and My Issues' active filter all read a state's type, not its name, so a category (e.g. every `completed` state) left empty would silently stop working rather than fail loudly. Create or keep another state of the same type first.