Skip to main content
POST
cURL
The new workflow’s draft starts at revision 0. Save a definition with the Save Draft API, then validate and publish it before running contacts.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Workflow to create.

name
string
required

Display name of the workflow.

Required string length: 1 - 120
Example:

"Loan follow-up"

Response

Workflow created

id
string<uuid>
required

Unique workflow id.

name
string
required

Display name.

status
enum<string>
required

Workflow status.

Available options:
active,
archived
latest_published_version
integer | null

Number of the newest published version, or null if nothing is published yet.

created_at
string<date-time>
updated_at
string<date-time>