Skip to main content
POST
Add Lead to Campaign

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 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:

Response

Lead added successfully. Returns status and confirmation message.

status
string
Example:

"success"

message
string