start_workflow
Start an audience workflow across email, voice, SMS, and landing pages. Use a built-in template or define custom steps; each run advances or terminates based on outcome events.
Instructions
Kick off a multi-channel workflow (email → voice → SMS → landing) for an audience. Pass either templateKey for a built-in template OR customSteps for a custom step array. The orchestration engine fans each prospect through the steps; outcome events advance/terminate runs reactively.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"offer_id": "<offer_id>",
"audience_upload_id": "<audience_upload_id>"
},
"name": "start_workflow"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| offer_id | Yes | Offer the agent has accepted. | |
| audience_upload_id | Yes | Audience id; one WorkflowRun is created per row. | |
| template_key | No | e.g. 'cold_outreach_3_step'. Mutually exclusive with custom_steps. | |
| custom_steps | No | Custom step list. Mutually exclusive with template_key. | |
| name | No | Optional human-readable name for the workflow definition. |