Skip to main content
POST
Schedule a workflow

Authorizations

Authorization
string
header
required

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

Path Parameters

workflow_id
string<uuid>
required

Unique identifier for a workflow.

Body

application/json
trigger_immediately
boolean | null

If true, the workflow will also be triggered immediately after scheduling.

Example:

false

Response

The workflow was scheduled successfully.

run_id
string | null

The run ID if the workflow was triggered immediately after scheduling.

Example:

"b7e3f1a2-4c5d-6e7f-8a9b-0c1d2e3f4a5b"