Skip to main content
PATCH
Update a lead for a specific campaign
Legacy endpoint - deprecated. Unversioned endpoints are scheduled for removal on July 31, 2026. A public v1 replacement is not currently listed in the v1 reference. This endpoint remains available for existing integrations until then.
Updates editable fields on a campaign lead, the phone_number, the metadata object that holds dynamic variables, and any free-form notes. Updates are only permitted while the lead is in pending status; once a call has been initiated, the lead’s data is locked so the call log can be reconciled cleanly against the configuration in effect at dial time.

When to use this

  • Data quality fixes: you discovered a typo in a phone number after uploading a batch and want to correct it before the campaign reaches that row.
  • Late variable updates: you want to add a personalization variable (for example customer_first_name) that was missing from the original upload, before the lead is dialled.
  • Re-categorization: you want to tag the lead with a different product or segment so the agent’s prompt branches correctly.
If the lead has already been dialled, the cleanest path is to leave the existing record alone and enroll a corrected version with Upload Campaign Leads. Removing and re-adding preserves the original call log for audit while letting the corrected record be re-attempted.

Path parameters

Errors

  • 404 Not Found is returned when the lead does not exist or has been removed.
  • 409 Conflict is returned when the lead has already been dialled and its data is locked.
  • 400 Bad Request is returned when phone_number is not in E.164 format.

Authorizations

Authorization
string
header
required

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

Path Parameters

campaignId
string
required

ID of the campaign

id
string
required

ID of the lead

Body

application/json
name
string

Updated name of the lead

Example:

"Jane Doe"

phoneNumber
number

Updated phone number of the lead

Example:

"+919876543211"

countryCode
string

Updated country code

Example:

"+91"

organisationId
string

Updated organisation ID (string of length 14)

Example:

"org_abc123xyz789"

campaignId
string

Updated campaign ID

Example:

6

notes
object

Optional notes JSON for the lead. Maximum 15 top-level keys.

Example:

Response

Lead updated successfully

id
string
required

Signed lead ID

Example:

"lead_abc123"