Skip to main content
PUT
Update Lead
Update a lead by providing the lead ID and the fields you want to change. Only the fields included in the request will be updated.

Path Parameters

integer
required
The ID of the lead to be updated

Request Body

integer
The ID of the campaign to which the lead should be assigned
string
The lead’s phone number (automatically formatted to E164)
string
The status of the lead. Must be one of the following values: created, completed, reached-max-retries
object
Custom variables to be merged with the existing lead variables

Response Fields

string
Success message indicating the lead was updated

Notes

  • The lead must belong to the authenticated user
  • When 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 status field has restricted values to maintain data integrity