Workflow Leads
Add Lead to Workflow
deprecated
Enrol a lead into a workflow via file upload.
POST
Upload CSV or Excel file with leads data
Enrols leads into a workflow by uploading a CSV or XLSX file. Each row in the file becomes one enrolled lead. The file must include a
Leads begin processing immediately once the workflow is active. Their progress through the nodes depends on the outcomes of each step.
phone_number column; all other columns become dynamic variables available in the agent’s prompt at each voice call step.
File format
Destination validation
If the workflow contains Voice Call nodes, uploaded leads are validated before enrollment. A lead’sphone_number must be valid and must be allowed by at least one active Voice Call phone number in the workflow.
For non-SIP routes, the destination country and prefix must be enabled in Workspace Settings > Telephony Config. Validation failures return 400 Bad Request with grouped row-level errors so you can fix the file and retry.Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
RSA encrypted organization ID (base64 format)
Example:
"BASE64_ENCRYPTED_ORG_ID_HERE"
Path Parameters
Body
multipart/form-data
CSV or Excel file with leads data
Response
File processed successfully
Upload CSV or Excel file with leads data