domains

POST `/v1/domains/{domainId}/email-routing/addresses`

Authentication

Send an API key as a bearer token. The key must carry the domains.dns.manage permission; a key without it is refused with 403, not 404.

This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X POST https://api.zinndigital.com/v1/domains/{domainId}/email-routing/addresses \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "email": <string> }'

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

This sends mail to a third party. The provider emails the address a verification link and will not deliver anything to it until the recipient clicks, so the response carries verified: false rather than pretending the destination is usable. Destination addresses are account-scoped at the provider, not zone-scoped: one address book serves every domain on the account. Requires domains.dns.manage.

Parameters

Name	Type	Required	What it is
`domainId (path)`	`Uuid`	Yes	The domain's id.

Request body

Name	Type	Required	What it is
`email`	`string`	Yes	The provider emails this address a verification link. It is a write that reaches a third party, so it is permissioned and audit-logged accordingly.

Response

Name	Type	Required	What it is
`address_id`	`string`	Yes	—
`email`	`string`	Yes	—
`verified`	`boolean`	Yes	A fact about the recipient's action, never ours: the provider emails a verification link and will not deliver until it is clicked.
`created`	`string`	Yes	—

Errors this endpoint can return

401 · 403 · 404 · 422 · 429 · 503

POST /v1/domains/{domainId}/email-routing/addresses