Authentication
Request
Must be
"update_status".The lead to update. Your company must have access to the channel this lead belongs to.
The target status name, exactly as defined on the channel (e.g.
"Qualified", "Won"). Use get_channels to retrieve the available statuses for a channel.The lead’s current status ID. Optional. Passed through to workflow triggers for conditional automation.
Response
Returns the updated lead object.Side effects
- Status event: An event record is created logging the status change.
- Reward triggers: If the channel has active reward triggers for
status_changematching the new status, reward events are created automatically. - Webhooks: If the channel has a
webhook_status_updateURL configured, a POST request is sent with the lead data and the new status name. - Notifications: The channel owner’s team receives an in-app notification.
Example
Request
Response
Errors
| Status | Error | Cause |
|---|---|---|
400 | "lead_id and status required" | One or both required fields are missing. |
401 | "Invalid API key" | Missing or invalid X-Api-Key header. |
403 | "Lead not accessible" | Your company does not have access to this lead’s channel. |
404 | "Status \"X\" not found for this channel" | The status name does not match any status defined on the lead’s channel. |