Campaign Leads
Update Campaign Lead
deprecated
Correct a campaign lead’s phone number, metadata, or notes before the call is placed. Locked once dialling begins.
PATCH
Update a lead for a specific campaign
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
productorsegmentso the agent’s prompt branches correctly.
Path parameters
Errors
404 Not Foundis returned when the lead does not exist or has been removed.409 Conflictis returned when the lead has already been dialled and its data is locked.400 Bad Requestis returned whenphone_numberis not in E.164 format.
Related endpoints
- Get Campaign Lead: confirm the new values.
- Upload Campaign Leads: bulk-add or re-add corrected leads.
- Remove Campaign Lead: remove the lead instead of editing.
- Dynamic Variables: how
metadatais referenced in agent prompts.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Updated name of the lead
Example:
"Jane Doe"
Updated phone number of the lead
Example:
"+919876543211"
Updated country code
Example:
"+91"
Updated organisation ID (string of length 14)
Example:
"org_abc123xyz789"
Updated campaign ID
Example:
6
Optional notes JSON for the lead. Maximum 15 top-level keys.
Example:
Response
Lead updated successfully
Signed lead ID
Example:
"lead_abc123"
Update a lead for a specific campaign