GET /v1/mail/reseller-brand
The mail hostnames this reseller's mail is published and served under.
Authentication
Send an API key as a bearer token. The key must carry the mail.view permission; a key without it is refused with 403, not 404.
Where your organisation id goes
This endpoint takes org_id as a query parameter. Leave it out and the call covers your whole tenancy subtree; send it to narrow the call to one organisation.
Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X GET https://api.zinndigital.com/v1/mail/reseller-brand \
-H "Authorization: Bearer zdk_live_…"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
Requires mail.view. An organization with no brand configured gets an empty one with configured: false rather than a 404 — the form is the same either way.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
org_id (query) | Uuid | No | The organization to read for; defaults to the caller's own when unambiguous. |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
name | string | No | What the reseller calls this brand, for their own screens. |
mx_hosts | string[] | Yes | Apex MX targets in priority order, on the reseller's own domain, pointed at the relay's addresses. Their names — an A record they publish, never a CNAME to ours, which would put… |
spf_include | string | Yes | The domain in the reseller's v=spf1 include:…. A delegation, so it must be a name whose SPF record they control and which in turn includes our sender list. |
autodiscover_host | string | Yes | — |
imap_host | string | Yes | — |
smtp_host | string | Yes | — |
webmail_host | string | Yes | Where the reseller's client's browser goes to read mail — the single most visible name in the whole product. |
configured | boolean | Yes | Whether every hostname the preset needs has been supplied. All-or-nothing: a half-set would publish the reseller's MX beside the platform's SPF include, which is a leak and a… |
verified_at | string | No | When these names were last confirmed to resolve to the relay. |
Errors this endpoint can return
401 · 403 · 429