Create workflow

Create workflow in the credential-bound company. Idempotency-Key is required and stores the terminal response for safe retries for 24 hours. This changes draft or operational data without posting accounting entries. Requires the workflows:write OAuth scope.

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

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

POST /v1/workflows. Name and the complete stage set are required; a brand
new workflow has nothing to remove, so remove_stage_ids is refused rather
than silently ignored.

string
required
length ≤ 255
string

Server-owned or nonexistent columns a client must never claim.

string
string
string
string
string
string
string
stages
array of objects
required
length between 1 and 30
stages*
remove_stage_ids
array of uuids
remove_stage_ids
Headers
string
required
length ≤ 191

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

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
*/*