Skip to main content
POST
cURL
reference_id is the contact’s identity within the workflow version: repeating it returns 409 duplicate_run with the existing execution_id, which makes the call safely retryable. When omitted, an identity is derived from the row’s content.
Fields declared by the start node can be passed flat at the top level — exactly like CSV columns — or nested under custom_fields. On a name collision the flat key wins. Undeclared keys are rejected with 422 unknown_field.

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

The unique id of the workflow

Body

application/json

One contact. Fields declared by the published version's start node may be passed flat at the top level (like CSV columns) or nested under custom_fields; a flat key wins on collision.

reference_id
string

Stable identity for this contact within the workflow version. Re-running the same reference_id returns 409 duplicate_run with the existing execution_id. When omitted, an identity is derived from the row's content.

Example:

"cand_101"

mobile_number
string

Contact's phone number in E.164 format. Required if the start node declares it required, or if the workflow dials it.

Example:

"+919876543210"

name
string

Contact's name.

email
string

Contact's email.

custom_fields
object

Values for fields declared by the start node, keyed by field name.

Response

Execution created

execution_id
string
required

Id of the created execution. Poll it with the Get Execution API.

campaign_id
string<uuid>
required

The implicit api-kind campaign that groups single runs of this workflow version.

workflow_version
integer
required

The published version the contact runs through.

status
enum<string>
required

Initial execution status.

Available options:
pending