Record an outreach outcome (becomes a learning label)
POST
/outcomesRequires scope: write:outcomes
Parameters
| Parameter | In | Type | Description |
|---|---|---|---|
Idempotency-Key | header | string | Stable caller event ID. Retrying it returns the original deal instead of recording the outcome twice. |
Request body
| Field | Type | Allowed values | Description |
|---|---|---|---|
store_idrequired | string | any string | |
actionrequired | string | contactedrepliedcall_bookedproposalwonlost | |
value | number | any number | Deal value, for won |
occurred_at | string | any string | |
note | string | any string |
Responses
| Status | Description |
|---|---|
200 | Recorded |
400 | Invalid body |
401 | Missing or invalid API key |
403 | Key lacks the required scope |
429 | Rate limit exceeded (see Retry-After) |
Is this page helpful?