Header Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Request body for POST /email-domains.
For kind='hail_mail' domain is omitted; the server composes
the full address as <local_prefix_user>+<local_prefix_org>@<base>.
Both prefixes are optional in the body and fall back to the
HAIL_MAIL_DEFAULT_*_PREFIX env vars; the server returns 503 if
neither is supplied. For kind='custom' domain is required and
the prefix fields must be omitted.
Response Body
application/json
application/json
curl -X POST "https://example.com/email-domains" \ -H "Content-Type: application/json" \ -d '{ "kind": "hail_mail" }'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6", "kind": "hail_mail", "domain": "string", "local_prefix_user": "string", "local_prefix_org": "string", "verification_status": "pending", "dns_records": [ { "name": "string", "value": "string", "type": "CNAME", "priority": 0 } ], "mail_from_domain": "string", "mail_from_status": "string", "provider": "string", "verified_at": "2019-08-24T14:15:22Z", "inbound_enabled": false, "forward_to": [ "string" ], "forward_rate_per_hour": 0, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "receive_ready": true}