Skip to main content
POST
Create Workflow

Authorizations

x-api-key
string
header
required

Your Sixtyfour API key.

Body

application/json
workflow_name
string
required

Human-readable workflow name.

Maximum string length: 200
workflow_description
string
required

Human-readable workflow description.

Maximum string length: 2000
workflow_definition
WorkflowGraph · object
required

Workflow definition as a graph of blocks and edges.

id
string | null

Optional pre-generated workflow ID supplied by the client.

Maximum string length: 200

Response

Successful Response

id
string
required

Workflow identifier.

name
string
required

Workflow name.

status
string
required

created for a saved workflow that can run, draft for one saved before it validates. After a run starts it holds the latest run's status, such as running, completed or failed.

created_at
string<date-time>
required

Timestamp when the record was created.

updated_at
string<date-time>
required

Timestamp when the record was last updated.

edit_revision
integer
default:0

Shared definition revision; unchanged by run progress or metadata flags.

Required range: x >= 0
user_uuid
string | null

User who created the workflow.

org_id
string | null

Organization that owns the workflow.

description
string | null

Workflow description.

display_status
WorkflowDisplayStatus · object | null

A label for the workflow's status.

last_run_date
string<date-time> | null

Timestamp of the most recent run.

team_id
string | null

Team that owns the workflow; null when it belongs to the organization rather than a team.

locked
boolean | null

Whether the graph is locked against edits.

block_count
integer | null

Number of blocks. List responses only.

workflow_definition
StoredGraph · object

The workflow's block graph. Detail responses only.