mail

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

SPF, DKIM and DMARC state for a domain that already has email.

Svi mail krajnji točke

Sva developerska dokumentacija

Autentifikacija

Pošaljite API ključ kao nosivi token. Ključ mora imati dozvolu mail.view; ključ bez nje se odbija s kodom 403, a ne 404.

Ova krajnja točka ne prihvaća ID organizacije. Vaš ključ već identificira organizaciju kojoj pripada, a odgovor je ograničen na nju.

Isprobajte

Zamijenite sve unutar šiljastih zagrada svojim vlastitim vrijednostima, a rezervirano mjesto za ključ s ključem iz vaše nadzorne ploče.

curl -X GET https://api.zinndigital.com/v1/mail/services/{mailServiceId}/deliverability \
  -H "Authorization: Bearer zdk_live_…"

Prijavljeni ste? API konzola na vašoj nadzornoj ploči automatski unosi stvarni ID vaše organizacije i vaš vlastiti ključ te šalje zahtjev prema aktivnom API-ju kako biste mogli vidjeti stvarni odgovor. Otvori ovu krajnju točku u API konzoli

Pojedinosti

Whether this domain's mail is set up to be delivered - the question a customer asks when their messages land in spam. ⛔ A different question from /preflight, which asks what setting mail up here would destroy; both read the same underlying report so a preview and the fix cannot disagree. fixable is false when the apex MX belongs to somebody else or the zone cannot be read, because a one-click apply would then either destroy working mail or write blind. Requires mail.view.

Parametri

NazivVrstaObaveznoŠto je to
mailServiceId (path)UuidDaEmail service ID (UUIDv7).

Odgovor

NazivVrstaObaveznoŠto je to
domainstringDa
healthybooleanDaAll three mechanisms present and ours - nothing to publish.
spf_okbooleanDa
dkim_okbooleanDa
dmarc_okbooleanDa
fixablebooleanDaWhether 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_confirmationbooleanDaTrue when applying would replace published records, so confirm is required.
existing_apex_mxstring[]Da
foreign_mxstring[]DaApex MX targets that are not ours - the reason a fix is refused.
foreign_spf_includesstring[]Da
would_deletestring[]DaRecords 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 ones…
zone_unreadablebooleanDa
reasonstringDaCustomer-grade English. Never a driver message.
warningsstring[]Da
live_mxstring[]DaThe domain's MX hosts as PUBLIC DNS answers them right now (W43-09) - not our record of the zone. Empty when the domain publishes no MX, or when it could not be read (see…
mx_readablebooleanDaFalse when the public MX lookup failed. A failed lookup is never read as "action needed".
mx_okbooleanDaEvery live MX host is one this preset publishes, and there is at least one.
action_neededbooleanDaThe customer's OWN DNS must change: we cannot publish to this zone and its live MX does not point where this preset sends mail. The panel then lists required_records with copy…
required_recordsobject[]DaThe exact records to publish, as our preset would write them into a zone we host.

Pogreške koje ova krajnja točka može vratiti

401 · 403 · 404 · 429