mail

POST `/v1/mail/services/{mailServiceId}/forwarders`

Forward an address, a catch-all, or a whole domain.

Authentication

Send an API key as a bearer token. The key must carry the mail.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/mail/services/{mailServiceId}/forwarders \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "targets": <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

source is required for mailbox and ignored for catchall/wildcard, where the whole domain is the source — so it may be omitted for those rather than sending a value the backend discards. Requires mail.manage.

Parameters

Name	Type	Required	What it is
`mailServiceId (path)`	`Uuid`	Yes	Email service ID (UUIDv7).

Request body

Name	Type	Required	What it is
`source`	`string`	No	Required for `mailbox`; ignored for `catchall`/`wildcard`. The part before the `@` (`info`), or a full address on this service's own domain (`info@example.com`, taken as `info`).…
`targets`	`string[]`	Yes	—
`kind`	`MailForwarderKind`	No	`mailbox` forwards one address; `catchall` takes anything not otherwise matched at the domain; `wildcard` forwards the whole domain to another one.

Response

Name	Type	Required	What it is
`id`	`string`	Yes	The mail backend's identifier.
`source`	`string`	Yes	The local part being forwarded for `mailbox`; the domain itself for `catchall`/`wildcard`.
`targets`	`string[]`	Yes	Where mail goes. May include the backend's reserved drop/reject targets.
`kind`	`MailForwarderKind`	Yes	`mailbox` forwards one address; `catchall` takes anything not otherwise matched at the domain; `wildcard` forwards the whole domain to another one.

Errors this endpoint can return

401 · 403 · 404 · 422 · 429 · 503

POST /v1/mail/services/{mailServiceId}/forwarders