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

Documentation Index

Fetch the complete documentation index at: https://developers.nlpearl.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Specify the authorization token.

For more information, check out the Authorization Guide.

Path Parameters

​
pearlId
string
required

Body

​
leads
object[] | null

Collection of leads to add to an outbound Pearl.

Constraints:

  • Max 50,000 leads.
  • Each lead must follow the validation rules defined in LeadToAddApi.

Response

All leads were added successfully.

The response is of type boolean.