Skip to content

Create a workspace workflow transition ​

POST/api/v2/workspaces/{slug}/workflows/{workflow_id}/state-transitions/

Allow a move from one chain state to another. The request names states by catalog state id. The response reports the source as workflow_state_id, the id of the source's chain entry.

When the source state's type is approval, the transition also carries the approval settings: member_ids, required_approvals, and rejection_state_id. Creating a transition from an approval state needs the Workflow approvals plan feature, or the request returns 402.

A workflow can hold one transition per source and target pair. Creating a second one returns 409 conflict.

Path Parameters ​

slug:requiredstring

The workspace slug. It appears in your Plane URLs. In https://app.plane.so/my-team/projects/, the slug is my-team.

workflow_id:requiredstring (uuid)

The catalog workflow the transitions belong to.

Body Parameters ​

state_id:requiredstring (uuid)

Catalog state id of the source. It must be in the workflow's chain, or the request returns 404.

transition_state_id:optionalstring (uuid)

Catalog state id of the target. It must be in the workflow's chain, or the request returns 400. Nullable.

rejection_state_id:optionalstring (uuid)

For a transition out of an approval state, the catalog state a rejected work item moves to. It must be in the workflow's chain, or the request returns 400. Nullable.

required_approvals:optionalinteger

How many approvals the move needs. null means every approver must approve. Nullable.

member_ids:optionalarray of string (uuid)

User ids of the approvers. Each must be an active member of the workspace, or the request returns 400.

Response shaping ​

fields:optionalstring

Comma-separated list of fields to return. Unrequested keys are omitted from the response, not returned as null, so absent means "not requested" and null means "actually null". id always comes back whether or not you name it.

Pass all for every requestable field. An unknown name is a 400 that lists the valid set and suggests the closest match, so a typo can't silently cost you the saving.

Requestable here: created_at, id, member_ids, rejection_state_id, required_approvals, transition_state_id, updated_at, workflow_state_id.

See Sparse fields.

Scopes ​

workspaces.workflows:write

Errors ​

StatusCodeCause
400invalid_requeststate_id is missing, a target or rejection state isn't in the chain, an approver isn't an active workspace member, or a field failed validation.
401unauthorizedMissing or invalid credentials.
402payment_requiredWorkflows isn't on your plan, or the source is an approval state and Workflow approvals isn't on your plan.
403forbiddenYour role or token scope can't edit workspace workflows.
404not_foundNo such workflow in this workspace's catalog, or the source state isn't in its chain.
406not_acceptableThe Accept header asks for a representation the API can't produce.
409conflictA transition between these two states already exists.
409governance_migration_in_progressA governance migration is running in this workspace, so writes are paused. Retry after it finishes.
409states_managed_at_projectThe workspace doesn't have governance turned on. Use the project's workflows instead.
413payload_too_largeThe request body is over the size limit.
415unsupported_media_typeThe Content-Type isn't one this endpoint accepts.
429rate_limitedThrottled. Honor the Retry-After header before retrying.
Create a workspace workflow transition
bash
curl -X POST \
  "https://api.plane.so/api/v2/workspaces/my-team/workflows/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/state-transitions/" \
  -H "X-Api-Key: $PLANE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "state_id": "b7e42a19-3c5d-4f80-9a26-8d1c0f4e7b53",
  "transition_state_id": "7b1e9d40-3c86-4f2a-9a5d-8e2b0c47d613",
  "rejection_state_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
  "required_approvals": 1,
  "member_ids": [
    "a3f92c71-6e4b-4d08-9b5a-1c7e3d9f2b84"
  ]
}'
Response201
json
{
  "id": "4b6e1d93-2a7f-4c58-9e30-1d8b5f7a2c46",
  "workflow_state_id": "c48f1a6d-2e7b-4d95-8c03-6b1e9f2a7d54",
  "transition_state_id": "7b1e9d40-3c86-4f2a-9a5d-8e2b0c47d613",
  "rejection_state_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
  "required_approvals": 1,
  "member_ids": ["a3f92c71-6e4b-4d08-9b5a-1c7e3d9f2b84"],
  "created_at": "2026-01-15T11:04:52.660219Z",
  "updated_at": "2026-01-15T11:04:52.660219Z"
}
Response400
json
{
  "type": "invalid_request",
  "code": "invalid_request",
  "detail": "Transition states must belong to the workflow chain."
}
Response409
json
{
  "type": "conflict",
  "code": "conflict",
  "detail": "A transition between these states already exists."
}