reseller
POST /v1/reseller/brand/sending-domain
Send your clients' e-mail from your own domain.
Autenticação
Envie uma chave de API como um token de portador. A chave deve ter a permissão reseller.manage; uma chave sem ela é recusada com 403, e não 404.
Onde vai o ID da sua organização
Este endpoint aceita org_id como parâmetro de consulta. Omita-o e a chamada abrangerá toda a sua subárvore de locatários; envie-o para restringir a chamada a uma única organização.
O ID da sua organização está na tela de chaves de API no seu painel, ao lado da própria chave. É o mesmo ID em todas as chamadas que você fizer.
Experimente
Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.
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> }'Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API
Detalhes
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.
Parâmetros
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
org_id (query) | Uuid | Não | The 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… |
Corpo da requisição
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
domain | string | Sim | Just the domain — `acme.com` or `mail.acme.com`, with no scheme and no path. |
Resposta
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
domain | string | Sim | — |
verified | boolean | Sim | The mail provider's answer. Never inferred from `domain` being set. |
provider | string | Sim | — |
provider_status | string | Sim | The provider's raw status word, for display. Never branch on it. |
records | BrandDnsRecord[] | Sim | — |
Erros que este endpoint pode retornar
401 · 403 · 409 · 422 · 429 · 503