Query Parameters
Request Body
application/x-www-form-urlencoded
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
text/html
text/html
application/json
curl -X POST "https://example.com/v1/unsubscribe?token=string" \ -H "Content-Type: application/x-www-form-urlencoded" \ -d ''"string"Unsubscribe
One-click email opt-out (RFC 8058). ``GET`` is a person clicking the link in a sent email. ``POST`` is the mailbox provider's unsubscribe button (Gmail, Yahoo), which sends the body ``List-Unsubscribe=One-Click``. The body is optional. Public and unauthenticated — the signed token query param is the sole credential, proving the caller holds a link Hail sent to that address. On success, the address is added to the org's suppression list and all future outbound email to it is blocked. Returns an HTML page, not JSON.
Update Agent
Change some fields. Fields left out keep their value; ``null`` clears first_message, ai_disclosure_line, tools, max_duration_seconds or handover_max_duration_seconds. Live calls keep the settings they started with. ``handover_contacts`` replaces the list; ``[]`` clears it and ``null`` leaves it.