GET
/
v1
/
Outbound
/
{outboundId}
/
Lead
/
Extrenal
/
{externalId}

Authorizations

Authorization
string
headerrequired

Specify the authorization token.

For more information, check out the Authorization Guide.

Path Parameters

outboundId
string
required

The unique identifier of the outbound campaign.

externalId
string
required

The external identifier of the lead within the outbound campaign.

Response

200 - text/plain
id
string | null

The unique identifier of the lead, represented as an ObjectId.

externalId
string | null

The identifier for the lead from an external system, such as a CRM.

phoneNumber
string | null

The phone number of the lead.

timeZone
string | null

The time zone of the lead, represented as a float (e.g., -5.0 for EST).

status
integer

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

30 - WrongCountryCode

40 - OnCall

100 - Success

110 - NotSuccessfull

130 - Complete

500 - Error

created
string

The date and time when the lead was created.

callsId
string[] | null

The list of the ID's of all the calls this lead has received.

lastCall
object
callData
object | null

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

{ "firstname" : "joe", "lastName": "Martin" , "carLicense" : "90-929-82" }