Authorizations
Specify the authorization token.
For more information, check out the Authorization Guide.
Path Parameters
The unique identifier of the outbound campaign to which the lead will be added.
Body
The lead details to be added to the outbound campaign.
The phone number of the lead.
1
An optional external identifier for the lead.
Optional time zone identifier for the lead.
If provided, this will override the default time zone configured at the outbound level.
By default, an outbound campaign has a predefined time zone (set during creation or modified later on the platform),
but you can assign a specific time zone to a lead by specifying this property.
If not provided, the lead will use the outbound's default time zone.
For valid values, refer to the "TimeZone" column in the following list:
Time Zone List
Examples: "Pacific Standard Time"
, "Türkiye Standard Time"
A dictionary containing additional information about the call. It is used as variables that you can use in "Opening Sentence" or "Flow Script" when you create a Pearl on the platform. The keys represent the field names, and the values contain the corresponding data. This information can be used to personalize the conversation or manage lead-specific details. This parameter is optional.
See Variables for more information. Here is an exemple of the json to send:
{ "email" : "joe@gmail.com", "address": "3 Abbey Road UK" , "carLicense" : "90-929-82" }
Response
Id of the added lead.