Skip to main content
POST
/
v1
/
api
/
voice-campaigns
/
{campaign_id}
/
leads
Add Lead to Voice Campaign
curl --request POST \
  --url https://api.voiceaiwrapper.app/v1/api/voice-campaigns/{campaign_id}/leads \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "tenant_id": "VGVuYW50OjEyMw==",
  "phone_number": "+14155552671",
  "first_name": "Jane",
  "last_name": "Doe",
  "email": "jane.doe@example.com",
  "custom_fields": {
    "company": "Acme Corp",
    "plan": "enterprise"
  }
}
'
{
  "status": "success",
  "message": "Lead added to the campaign successfully"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
campaign_id
string
required

Identifier of the voice campaign. Required.

Example:

"camp_abc123"

Body

application/json

Lead details to add to the campaign

​
tenant_id
string
required

Tenant global ID (base64-encoded). Required.

Example:

"VGVuYW50OjEyMw=="

​
phone_number
string
required

Lead phone number in E.164 format. Required.

Example:

"+14155552671"

​
first_name
string

Lead first name. Optional.

Example:

"Jane"

​
last_name
string

Lead last name. Optional.

Example:

"Doe"

​
email
string<email>

Lead email address. Optional.

Example:

"jane.doe@example.com"

​
custom_fields
object

Additional key-value pairs for call script personalisation. Optional.

Example:
{
  "company": "Acme Corp",
  "plan": "enterprise"
}

Response

Lead added successfully. Returns status and confirmation message.

​
status
string
Example:

"success"

​
message
string