mail

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

Publish this domain's mail records.

모든 mail 엔드포인트

인증

Bearer 토큰으로 API 키를 전송하세요. 키는 반드시 mail.manage 권한을 가지고 있어야 하며, 권한이 없는 키는 404가 아닌 403으로 거부됩니다.

이 엔드포인트는 조직 ID를 받지 않습니다. 사용자의 키가 이미 속한 조직을 식별하며, 응답은 해당 조직으로 한정됩니다.

무료 체험하기

대괄호 안에 있는 모든 내용을 사용자 지정 값으로 바꾸고, 키 플레이스홀더는 대시보드의 키로 바꾸세요.

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

로그인하셨나요? 대시보드의 API 콘솔이 실제 조직 ID와 본인의 키를 자동으로 채우고 라이브 API를 대상으로 요청을 실행하므로 실제 응답을 확인할 수 있습니다. API 콘솔에서 이 엔드포인트를 여세요

상세 정보

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`.

매개변수

이름유형필수설명
mailServiceId (path)UuidEmail service ID (UUIDv7).

요청 본문

이름유형필수설명
confirmboolean아니요Required when `needs_confirmation` is true. Defaults to false so a destructive apply is never a side effect of clicking "fix".

응답

이름유형필수설명
domainstring
healthybooleanAll three mechanisms present and ours - nothing to publish.
spf_okboolean
dkim_okboolean
dmarc_okboolean
fixablebooleanWhether 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_confirmationbooleanTrue when applying would replace published records, so `confirm` is required.
existing_apex_mxstring[]
foreign_mxstring[]Apex MX targets that are not ours - the reason a fix is refused.
foreign_spf_includesstring[]
would_deletestring[]Records 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_unreadableboolean
reasonstringCustomer-grade English. Never a driver message.
warningsstring[]

이 엔드포인트가 반환할 수 있는 오류

401 · 403 · 404 · 409 · 422 · 429