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)`	`Uuid`	예	Email service ID (UUIDv7).

요청 본문

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

응답

이름	유형	필수	설명
`domain`	`string`	예	—
`healthy`	`boolean`	예	All three mechanisms present and ours - nothing to publish.
`spf_ok`	`boolean`	예	—
`dkim_ok`	`boolean`	예	—
`dmarc_ok`	`boolean`	예	—
`fixable`	`boolean`	예	Whether 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_confirmation`	`boolean`	예	True when applying would replace published records, so `confirm` is required.
`existing_apex_mx`	`string[]`	예	—
`foreign_mx`	`string[]`	예	Apex MX targets that are not ours - the reason a fix is refused.
`foreign_spf_includes`	`string[]`	예	—
`would_delete`	`string[]`	예	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 ones…
`zone_unreadable`	`boolean`	예	—
`reason`	`string`	예	Customer-grade English. Never a driver message.
`warnings`	`string[]`	예	—
`live_mx`	`string[]`	예	The 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_readable`	`boolean`	예	False when the public MX lookup failed. A failed lookup is never read as "action needed".
`mx_ok`	`boolean`	예	Every live MX host is one this preset publishes, and there is at least one.
`action_needed`	`boolean`	예	The 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_records`	`object[]`	예	The exact records to publish, as our preset would write them into a zone we host.

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

401 · 403 · 404 · 409 · 422 · 429

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

인증