Path Parameters
| Parameter | Type | Description |
|---|---|---|
id | integer | The campaign ID. |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | The lead’s display name. |
phone_number | string | Yes | Phone number in E.164 format (e.g., +15551234567). |
lead_timezone | string | No | IANA timezone for the lead. If set, the scheduler respects the lead’s local time for the calling window. |
custom_vars | object | No | Arbitrary key-value data attached to the lead. Accessible by the assistant during the call. |
Example Request
{
"name": "Jane Smith",
"phone_number": "+15559876543",
"lead_timezone": "America/Chicago",
"custom_vars": {
"company": "Acme Corp",
"deal_stage": "proposal"
}
}
Response
Returns the created lead object withstate: "pending".
{
"success": true,
"data": {
"id": 42,
"campaign_id": 1,
"name": "Jane Smith",
"phone_number": "+15559876543",
"lead_timezone": "America/Chicago",
"custom_vars": {
"company": "Acme Corp",
"deal_stage": "proposal"
},
"state": "pending",
"attempt_count": 0,
"last_outcome": null,
"last_attempt_at": null,
"created_at": "2025-01-10T15:00:00",
"updated_at": "2025-01-10T15:00:00"
}
}