PUT
/
v1
/
Outbound
/
{outboundId}
/
Lead

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 to which the lead will be added.

Body

phoneNumber
string
required

The phone number of the lead.

Minimum length: 1
externalId
string | null

An optional external identifier for the lead.

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:

{ "email" : "joe@gmail.com", "address": "3 Abbey Road UK" , "carLicense" : "90-929-82" }

Response

200 - text/plain
leadId
string | null