Leads
Create lead
Create a new lead in the VoxLink system
On this page
This endpoint allows you to create a new lead in the VoxLink system.
Request body
phone_numberstringrequired
The phone number of the lead in E.164 format (e.g. +1234567890)
campaign_idintegerrequired
The ID of the campaign to create the lead for
variablesobject
Custom variables for the lead. For call campaigns, use variables defined on your assistant (see Call variables). For WhatsApp/SMS campaigns, use the keys referenced by your template mapping or SMS body placeholders.
allow_dupplicateboolean
Whether to allow duplicate leads in a campaign.
secondary_contactsarray
Call campaigns only. Extra phone numbers for the same lead. Rejected for WhatsApp/SMS campaigns.
Response
messagestring
The message of the response
dataobject
The lead data object
{
"message": "Lead created successfully",
"data": {
"id": 1,
"campaign_id": 1,
"phone_number": "+1234567890",
"variables": {
"customer_name": "John Doe",
"email": "john.doe@example.com"
},
"status": "created",
"created_at": "2025-06-30 11:53:20",
"updated_at": "2025-06-30 11:53:20",
"campaign": {
"id": 1,
"name": "My new campaign"
},
"secondary_contacts": [
{
"id": 2,
"phone_number": "+1234567891",
"variables": {
"customer_name": "Jane Doe Secondary",
"email": "jane.doe.secondary@example.com"
},
"status": "created",
"created_at": "2025-06-30 11:53:20",
"updated_at": "2025-06-30 11:53:20"
},
{
"id": 3,
"phone_number": "+1234567892",
"variables": {
"customer_name": "Bob Doe Office",
"email": "bob.doe.office@example.com"
},
"status": "created",
"created_at": "2025-06-30 11:53:20",
"updated_at": "2025-06-30 11:53:20"
}
]
}
}
Related guides
Leads
Leads Overview
Manage your campaign contacts with primary leads, secondary contacts, and custom variables
Read guide →Leads
Managing Leads
Create, edit, and organize leads with custom variables and secondary contacts
Read guide →Leads
Importing Leads
Import leads from CSV and Excel files with validation and error handling
Read guide →Leads
List leads
List all leads for the authenticated user with filtering and pagination options
Read guide →