---
title: "Add Leads"
method: POST
path: "/v2/Outbound/{pearlId}/Leads/Add"
tags: ["Outbound"]
---

# Add Leads

`POST /v2/Outbound/{pearlId}/Leads/Add`

Adds new leads to a specified outbound

## Path parameters

- `pearlId` string, required

## Request body

- LeadsToAddApi
  - `leads` LeadToAddApi[], nullable — Collection of leads to add to an outbound Pearl. Constraints: - Max 50,000 leads. - Each lead must follow the validation rules defined in LeadToAddApi.
    - `phoneNumber` string, required — The phone number of the lead.
    - `externalId` string, nullable — An optional external identifier for the lead.
    - `timeZoneId` string, nullable — 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](https://learn.microsoft.com/en-us/windows-hardware/manufacture/desktop/default-time-zones?view=windows-11) Examples: `"Pacific Standard Time"`, `"Türkiye Standard Time"`
    - `callData` object, nullable — 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](/pages/variables) for more information. Here is an example of the json to send: `{ "email" : "joe@gmail.com", "address": "3 Abbey Road UK" , "carLicense" : "90-929-82" }`

## Response `200`

All leads were added successfully.

- boolean

## Other responses

- `400` — The request is invalid or some leads could not be added. The response may contain validation errors or a list of failed leads with their associated errors.

---

[API](https://skmtc.net/nlpearl/apis/nlpearl-client-api.md) · [All operations](https://skmtc.net/nlpearl/apis/nlpearl-client-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nlpearl/nlpearl-client-api/versions/52d64fc5d6e9/schema)