Skip to main content
PUT
Run a workflow

Authorizations

x-api-key
string
header
required

API key for authentication

Path Parameters

workflowId
string
required

The ID of the workflow to run

Body

application/json
variables
object

Optional variables to pass to the workflow execution

limit
number

Optional limit for the number of records to process

Example:

100

Response

Workflow started successfully

message
string
Example:

"Workflow started"

jobId
string

The ID of the created job

status
string

The status of the job

Example:

"running"