ChatGPT ↗
Claude ↗This page documents the canonical HTTP contract for this endpoint.
At least one of emails, emailAddresses, phones, or phoneNumbers is required. Entries may be strings or objects; email objects require address (or alias email), phone objects require number (or alias phone). The handler merges channels, returns a summary, and serializes the returned lead. The request currently accepts untyped list items (Any); consult the returned lead for canonical channel shape.
Path parameters
lead_idrequiredstring
| Name | Type | Description |
|---|---|---|
| lead_idrequired | string | - |
Body parameters
emails· optionalarray
emailAddresses· optionalarray
Alias accepted by the HTTP request model.
phones· optionalarray
phoneNumbers· optionalarray
Alias accepted by the HTTP request model.
| Name | Type | Description |
|---|---|---|
| emails | array | - |
| emailAddresses | array | Alias accepted by the HTTP request model. |
| phones | array | - |
| phoneNumbers | array | Alias accepted by the HTTP request model. |
Errors
| Status | Meaning |
|---|---|
| 401 | Missing or invalid authentication. |
| 403 | Missing leads:write scope. |
| 404 | Lead not found. |
| 422 | At least one contact channel array is required. |