Path Parameters
uuidHeader Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
PATCH /agents/{id}. Fields left out keep their value; null clears
the nullable ones (first_message, ai_disclosure_line, tools,
max_duration_seconds).
Response Body
application/json
application/json
curl -X PATCH "https://example.com/v1/agents/497f6eca-6276-4993-bfeb-53cbbbba6f08" \ -H "Content-Type: application/json" \ -d '{}'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6", "name": "string", "system_prompt": "string", "first_message": "string", "ai_disclosure": true, "ai_disclosure_line": "string", "voice_config": {}, "tools": [ "string" ], "max_duration_seconds": 0, "voice_enabled": true, "sms_enabled": true, "status": "live", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z"}Unsubscribe
One-click email opt-out (RFC 8058), reached by clicking a link in a sent email. 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.
Create Email Attachment
Upload a file and get back a reusable attachment id. The returned id can be referenced from attachment_ids on many later POST /v1/emails calls until it is garbage-collected for being unused; it is not deleted immediately after first use. Uploads are size-limited and scoped to the caller's organization.