hail.sodocs
POST
/v1/contacts

Header Parameters

authorization?string|null

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/v1/contacts" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'
{  "id": "string",  "kind": "member",  "name": "string",  "phone_e164": "string",  "email": "string",  "role": "string"}

Create Call

Place an outbound AI voice call. The call is placed asynchronously — this returns as soon as the call is queued, not when it completes. Poll GET /v1/calls/{call_id} or configure a webhook to get the final status and transcript. Requires recipient_consent=true on the request body; Hail does not verify lawful basis to contact the recipient, the caller warrants it.

Create Email Domain

Register a sender identity to send outbound email through. kind="hail_mail" mints an address on the shared hail-mail domain and is immediately verified — no DNS work needed. kind="custom" registers your own domain with SES and returns DKIM records; the domain stays unverified (POST /v1/email-domains/{domain_id}/verify) until you publish those DNS records and Hail confirms them.