POST
/
v1
/
Outbound
/
{outboundId}
/
Leads
curl --request POST \
  --url https://api.nlpearl.ai/v1/Outbound/{outboundId}/Leads \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "skip": 123,
  "limit": 123,
  "sortProp": "<string>",
  "isAscending": true,
  "statuses": [
    123
  ],
  "searchInput": "<string>"
}'
{
  "count": 123,
  "results": [
    {
      "id": "<string>",
      "externalId": "<string>",
      "phoneNumber": "<string>",
      "timeZone": "<string>",
      "status": 123,
      "created": "2023-11-07T05:31:56Z",
      "callData": {}
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Specify the authorization token.

For more information, check out the Authorization Guide.

Path Parameters

​
outboundId
string
required

The unique identifier of the outbound.

Body

Search criteria for the leads.

Extends TableSearch to include specific search criteria for leads.

​
skip
integer

Number of entries to skip for pagination.

​
limit
integer

Limit on the number of entries to return.

​
sortProp
string | null

Property name to sort by.

​
isAscending
boolean

Whether the sort order is ascending.

​
statuses
integer[] | null

Optional filters for the status of the leads. Only leads with this status will be included in the results.

1 - New

10 - NeedRetry

20 - InCallQueue

30 - WrongCountryCode

40 - OnCall

70 - VoiceMailLeft

100 - Success

110 - NotSuccessfull

130 - Complete

150 - Unreachable

500 - Error

The Status of the lead is the status of the last conversation.

To determine the definition of 'Success' or 'Not Successful,' please refer to the Create a Pearl page at step 4.

1 - New

10 - NeedRetry

20 - InCallQueue

30 - WrongCountryCode

40 - OnCall

70 - VoiceMailLeft

100 - Success

110 - NotSuccessfull

130 - Complete

150 - Unreachable

500 - Error

​
searchInput
string | null

Text to filter by.

Response

200
text/plain
List of leads for the outbound.
​
count
integer

The total number of items matching the search criteria.

​
results
object[] | null

The list of results for the current page, based on the search criteria.

Add LeadGet Lead