Skip to main content
Updates an existing lead. Only the fields you provide in the request body are changed.

Endpoint

PUT /user/leads/{id}

Path parameters

integer
required
ID of the lead to update.

Request

integer
ID of the campaign to assign the lead to. Must belong to your account.
string
New phone number for the lead. Automatically formatted to E.164.
string
New status. Allowed values: created, completed, reached-max-retries.
Only a subset of statuses can be set manually. Statuses like processing and scheduled are assigned automatically by the system.
object
Variables to merge with existing lead variables. Existing keys are updated; new keys are added.

Response

string
Confirmation that the lead was updated.

Example

200 Success
404 Not found
422 Validation error