Skip to main content
POST
/
v2
/
Outbound
/
{pearlId}
/
Lead
Add Lead
curl --request POST \
  --url https://api.nlpearl.ai/v2/Outbound/{pearlId}/Lead \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phoneNumber": "<string>",
  "externalId": "<string>",
  "timeZoneId": "<string>",
  "callData": {}
}
'
{
  "leadId": "<string>"
}

Authorizations

​
Authorization
string
header
required

Specify the authorization token.

For more information, check out the Authorization Guide.

Path Parameters

​
pearlId
string
required

Body

​
phoneNumber
string
required

The phone number of the lead.

Minimum string length: 1
​
externalId
string | null

An optional external identifier for the lead.

​
timeZoneId
string | null

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"

​
callData
object

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 example of the json to send:

{ "email" : "[email protected]", "address": "3 Abbey Road UK" , "carLicense" : "90-929-82" }

Response

Id of the added lead.

​
leadId
string | null