Lead Object
A lead is a person a campaign calls. The API returns leads with the following fields:
| Field | Type | Description |
|---|---|---|
id | UUID | Lead identifier. |
campaign_id | UUID | Campaign the lead belongs to. |
first_name | string | Lead's first name. |
phone_e164 | string | Phone in E.164 form, e.g. +919876543210. |
status | string | new · in_progress · rescheduled · done · stopped · dnc. |
custom_fields | object | Extra variables for the campaign. |
calls_count | integer | Number of calls attempted on this lead. |
updated_at | datetime | Last modified (IST). |
next_scheduled_call | datetime | null | Next scheduled call, if any. |
Status is system-managed. It cannot be set through the API. Use
POST /api/v1/leads/{lead_id}/stopto stop a lead.