mail

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

Publish this domain's mail records.

Všechny koncové body mail

Autentizace

Zašlete API klíč jako nosný token (bearer token). Klíč musí mít oprávnění mail.manage; klíč bez něj je odmítnut s kódem 403, nikoli 404.

Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.

Vyzvednout

Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.

curl -X POST https://api.zinndigital.com/v1/mail/services/{mailServiceId}/deliverability \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API

Podrobnosti

Write the correct SPF, DKIM and DMARC records into the domain's zone. ⛔ Refuses with `422` when the apex MX is somebody else's - that is not a state to confirm past from this screen, because the customer's mail is being delivered today and this button must never be how that stops. When records would be **replaced**, answers `409` until `confirm: true` is sent, so a destructive apply is always a deliberate second act (the confirm-gated shape #622 forced on DNS). Requires `mail.manage`.

Parametry

NázevTypPožadovánoCo to je
mailServiceId (path)UuidAnoEmail service ID (UUIDv7).

Tělo požadavku

NázevTypPožadovánoCo to je
confirmbooleanNeRequired when `needs_confirmation` is true. Defaults to false so a destructive apply is never a side effect of clicking "fix".

Odpověď

NázevTypPožadovánoCo to je
domainstringAno
healthybooleanAnoAll three mechanisms present and ours - nothing to publish.
spf_okbooleanAno
dkim_okbooleanAno
dmarc_okbooleanAno
fixablebooleanAnoWhether a one-click apply is offered. **False** over a foreign apex MX or an unreadable zone - the panel shows the reason instead of a button.
needs_confirmationbooleanAnoTrue when applying would replace published records, so `confirm` is required.
existing_apex_mxstring[]Ano
foreign_mxstring[]AnoApex MX targets that are not ours - the reason a fix is refused.
foreign_spf_includesstring[]Ano
would_deletestring[]AnoRecords an apply would remove or replace, as `NAME TYPE VALUE`. Listed verbatim rather than counted: a customer must not be able to destroy mail records without seeing which one…
zone_unreadablebooleanAno
reasonstringAnoCustomer-grade English. Never a driver message.
warningsstring[]Ano

Chyby, které může tento koncový bod vrátit

401 · 403 · 404 · 409 · 422 · 429