Skip to main content
POST
Trigger a workflow

Authorizations

Authorization
string
header
required

Your API key, e.g. sk_live_... or sk_test_....

Headers

Idempotency-Key
string

Optional. Makes this write safe to retry: the same key replays the first response instead of acting twice.

Maximum string length: 255

Path Parameters

workflow
string
required

Workflow uuid.

Body

application/json
contact_id
string

Contact uuid to run the workflow for.

phone_number
string

Alternative to contact_id.

Maximum string length: 32
payload
object

Response

Started.

execution
object