Create workflow transition

Create workflow transition in the credential-bound company. Idempotency-Key is required and stores the terminal response for safe retries for 24 hours. If-Match is required with the latest ETag; stale versions return 412. This changes draft or operational data without posting accounting entries. Requires the workflows:action OAuth scope.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params

Fields accepted to create workflow transition. The schema identifies required and optional values.

POST /v1/workflows/{id}/transitions.

entity_type is constrained to {@see WorkflowTransitionEntityRegistry::types()}
— the closed code registry, not a free string — so an unregistered value is a
422 validation_error naming entity_type, never a lookup against an
attacker-chosen table. The enum also reaches the generated OpenAPI schema and
the MCP tool schema, so a client can discover what is transitionable.

If-Match IS REQUIRED, AND IT IS THE ENTITY'S ETag — not the workflow's. A
transition changes the entity named by entity_id; the workflow in the path
only says which board the stage must belong to, and is itself unchanged. So
the precondition is checked against that entity's version: send the ETag this
operation returned last time, or * to move an entity this credential has
never read (the public read for project tasks arrives with the tasks family).
Sending the workflow's ETag is refused with 412 and a message that says so,
because it would otherwise never match at any version.

string
enum
required
Allowed:
uuid
required
uuid
required
Headers
string
required
length ≤ 191

Required unique key whose request hash and terminal response are stored durably for 24 hours.

string

Required. ETag from the latest representation; a stale value returns 412 precondition_failed. Send this header, not the standard If-Match: some HTTP intermediaries evaluate a standard If-Match themselves and can answer 412 even though the change was applied. Never send both; both with different ETags returns 400 conflicting_precondition_headers.

string
deprecated

Accepted with the same value and meaning as Cybooks-If-Match, but do not send it: an intermediary can answer 412 to it after the change was applied. Send Cybooks-If-Match instead.

Responses

Language
Credentials
OAuth2
Missing 1 required scope
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*