reseller

POST /v1/reseller/brand/sending-domain

Send your clients' e-mail from your own domain.

All reseller endpoints

Authentication

Send an API key as a bearer token. The key must carry the reseller.manage 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 POST https://api.zinndigital.com/v1/reseller/brand/sending-domain \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "domain": <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

Registers a sending domain and returns the DNS records to publish. Requires `reseller.manage`. ⛔ **This is the largest single white-label leak and no template change could close it.** Everything inside a notification was already resolved to your brand — the name, the call-to-action link — while the envelope still read `Zinn Digital® Billing <billing@zinndigital.com>`, which is the line your client actually looks at. ⛔ Attaching does **not** switch the sender. Publish the records, then call `/verify`; only a successful verification moves your mail onto your domain, because mail from an unverified domain does not arrive. A domain is already attached ⇒ `409`. Remove it first — replacing it silently would orphan the previous one at the provider.

Parameters

NameTypeRequiredWhat it is
org_id (query)UuidNoThe organization this call acts on. Optional for a caller with exactly one direct membership; **required** for anyone with more than one — which is every reseller and every agen…

Request body

NameTypeRequiredWhat it is
domainstringYesJust the domain — `acme.com` or `mail.acme.com`, with no scheme and no path.

Response

NameTypeRequiredWhat it is
domainstringYes
verifiedbooleanYesThe mail provider's answer. Never inferred from `domain` being set.
providerstringYes
provider_statusstringYesThe provider's raw status word, for display. Never branch on it.
recordsBrandDnsRecord[]Yes

Errors this endpoint can return

401 · 403 · 409 · 422 · 429 · 503