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>",
      "timeZoneId": "<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.

Response

200
text/plain

List of leads for the outbound.

The response is of type object.