Skip to main content
PATCH
/
v1
/
api
/
voice-campaigns
/
{campaign_id}
/
lead
/
update
Update Lead in Voice Campaign
curl --request PATCH \
  --url https://api.voiceaiwrapper.app/v1/api/voice-campaigns/{campaign_id}/lead/update \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone_number": "+14155552671",
  "first_name": "Jane",
  "last_name": "Doe",
  "email": "jane.doe@example.com",
  "do_not_call": false,
  "custom_fields": {
    "plan": "pro"
  },
  "mark_as_unanswered": true
}
'
{
  "status": "success",
  "message": "Lead updated successfully"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
campaign_id
string
required

Identifier of the voice campaign. Required.

Example:

"camp_abc123"

Body

application/json

Lead fields to update

​
phone_number
string
required

Phone number of the lead to update (used as identifier). Required.

Example:

"+14155552671"

​
first_name
string

Updated first name. Optional.

Example:

"Jane"

​
last_name
string

Updated last name. Optional.

Example:

"Doe"

​
email
string<email>

Updated email address. Optional.

Example:

"jane.doe@example.com"

​
do_not_call
boolean

When true, marks the lead as opted out and prevents future calls. Optional.

Allowed values: true, false.

Example:

false

​
custom_fields
object

Updated custom key-value fields. Optional.

Example:
{ "plan": "pro" }
​
mark_as_unanswered
boolean

When true, resets the lead's answered status and re-queues them for outbound calling. Only applies when the lead is currently marked as answered. Optional.

Allowed values: true, false.

Example:

true

Response

Lead updated successfully. Returns status and confirmation message.

​
status
string
Example:

"success"

​
message
string