Leads
Update Lead
Update an existing lead in your campaigns
PUT
/ user / leads / {id}
Update a lead by providing the lead ID and the fields you want to modify. Only the fields provided in the request will be updated.
Path Parameters
id integer requiredThe ID of the lead to update
Body Parameters
campaign_id integerThe ID of the campaign to assign the lead to
phone_number stringThe phone number of the lead (will be formatted to E164)
status stringThe status of the lead. Must be one of:
created,
completed,
reached-max-retries
variables objectCustom variables to merge with existing lead variables
Response
message stringSuccess message indicating the lead was updated
Notes
- The lead must belong to the authenticated user
- If updating the campaign, the new campaign must also belong to the authenticated user
- Phone numbers are automatically formatted and validated
- Variables are merged with existing variables (not replaced)
- Only allowed fields can be updated:
campaign_id,phone_number,status,variables - The
statusfield has restricted values for data integrity