Skip to main content
PUT
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

integer
required
The ID of the lead to update

Body Parameters

integer
The ID of the campaign to assign the lead to
string
The phone number of the lead (will be formatted to E164)
string
The status of the lead. Must be one of: created, completed, reached-max-retries
object
Custom variables to merge with existing lead variables

Response

string
Success 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 status field has restricted values for data integrity