Skip to content

Update a workflow transition ​

PATCH/api/v2/workspaces/{slug}/projects/{project_id}/workflows/{workflow_id}/state-transitions/{pk}/

Update a workflow transition. Workflow transitions define the allowed moves between workflow states, and who may approve them. Send only the keys you want to change. Omitted keys keep their current value, and an explicit null clears a nullable field.

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.

project_id:requiredstring

The project the resource belongs to. Accepts the project UUID or its bare identifier, for example ENG.

workflow_id:requiredstring (uuid)

The workflow the resource belongs to.

pk:requiredstring (uuid)

The workflow transition id.

Body parameters ​

member_ids:optionalarray of string (uuid)

Ids of the members who may approve the transition. Replaces the current set.

rejection_state_id:optionalstring (uuid)

Id of the state a work item moves to when the transition is rejected.

Nullable.

required_approvals:optionalinteger

How many approvals a transition needs before it may run.

Nullable.

state_id:optionalstring (uuid)

Project state id of the source state.

transition_state_id:optionalstring (uuid)

Id of the state the transition moves a work item to.

Nullable.

Response shaping ​

fields:optionalstring

Comma-separated list of fields to return. Fields you don't request are left out of the response instead of coming back as null. id is always included. Pass all to get every requestable field. An unknown field name returns 400. See Sparse fields.

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

Scopes ​

projects.workflows:write

Errors ​

StatusCodeCause
400invalid_requestThe request body or a query parameter failed validation.
401unauthorizedMissing or invalid credentials.
402payment_requiredThe Workflows feature isn't on your plan, or is turned off.
403forbiddenYour role or token scope doesn't allow this.
404not_foundNo such resource, or it's outside your tenant.
406not_acceptableThe Accept header asks for a representation the API can't produce.
409governance_migration_in_progressA governance migration is running in this workspace, so writes are paused. Retry after it finishes.
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.
Update a workflow transition
bash
curl -X PATCH \
  "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/workflows/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/state-transitions/8f4c2b1e-0d3a-4f7b-9c21-6e5a8b7d4f13/" \
  -H "X-Api-Key: $PLANE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "member_ids": ["16c61a3a-512a-48ac-b0be-b6b46fe6f430"],
  "rejection_state_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
  "required_approvals": 1
}'
Response200
json
{
  "created_at": "2026-01-14T09:22:41.478363Z",
  "updated_at": "2026-02-03T16:45:12.904117Z",
  "created_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "updated_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "id": "b7e42a19-3c5d-4f80-9a26-8d1c0f4e7b53",
  "member_ids": ["16c61a3a-512a-48ac-b0be-b6b46fe6f430"],
  "rejection_state_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
  "required_approvals": 1,
  "transition_state_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
  "workflow_state_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f"
}
Response404
json
{
  "type": "not_found",
  "code": "not_found",
  "detail": "No workflow transition matches the given query."
}