PUT
/
v1
/
Outbound
/
{outboundId}
/
Lead
/
{leadId}
Update Lead
curl --request PUT \
  --url https://api.nlpearl.ai/v1/Outbound/{outboundId}/Lead/{leadId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "phoneNumber": "<string>",
  "externalId": "<string>",
  "timeZoneId": "<string>",
  "callData": {},
  "status": 123
}'
{
  "id": "<string>",
  "externalId": "<string>",
  "phoneNumber": "<string>",
  "timeZone": "<string>",
  "status": 123,
  "created": "2023-11-07T05:31:56Z",
  "callsId": [
    "<string>"
  ],
  "lastCall": {
    "id": "<string>",
    "startTime": "2023-11-07T05:31:56Z",
    "pearlId": "<string>",
    "status": 123,
    "from": "<string>",
    "name": "<string>",
    "collectedData": {
      "transcript": [
        {
          "role": 123,
          "content": "<string>",
          "startTime": 123,
          "endTime": 123
        }
      ],
      "collectedInfos": [
        {
          "id": "<string>",
          "name": "<string>",
          "value": "<any>"
        }
      ]
    },
    "summary": "<string>",
    "duration": 123,
    "recording": "<string>",
    "tags": [
      "<string>"
    ]
  },
  "callData": {},
  "collectedData": {}
}

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 campaign.

​
leadId
string
required

The unique identifier of the lead to update.

Body

The updated lead information.

Represents the data used to update an existing lead in an outbound campaign. All fields are optional; only the provided values will be updated.

Response

200
text/plain

The updated lead is returned.

The response is of type object.