mail

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

Publish this domain's mail records.

ყველა mail ენდპოინტი

ყველა დეველოპერის დოკუმენტაცია

ავტორიზაცია

API გასაღები გაგზავნეთ როგორც მატარებელი ტოკენი (bearer token). გასაღებს უნდა ჰქონდეს mail.manage ნებართვა; ამის გარეშე გასაღები უარყოფილი იქნება 403 და არა 404 სტატუსით.

ეს ბოლო წერტილი არ იღებს ორგანიზაციის იდენტიფიკატორს. თქვენი გასაღები უკვე აიდენტიფიცირებს იმ ორგანიზაციას, რომელსაც ის ეკუთვნის, და პასუხი შემოფარგლულია მისით.

სცადეთ

შეSubstituted any value inside angle brackets with your own and the key placeholder with a key from your dashboard.

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-ს წინააღმდეგ, რათა იხილოთ რეალური პასუხი. გაAღით ეს ენდპოინტი 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).

მოთხოვნის სხეული

სახელიტიპისავალდებულორა არის ეს
confirmbooleanარაRequired when needs_confirmation is true. Defaults to false so a destructive apply is never a side effect of clicking "fix".

პასუხი

სახელიტიპისავალდებულორა არის ეს
domainstringდიახ
healthybooleanდიახAll three mechanisms present and ours - nothing to publish.
spf_okbooleanდიახ
dkim_okbooleanდიახ
dmarc_okbooleanდიახ
fixablebooleanდიახ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_confirmationbooleanდიახTrue 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 ones…
zone_unreadablebooleanდიახ
reasonstringდიახCustomer-grade English. Never a driver message.
warningsstring[]დიახ
live_mxstring[]დიახ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_readablebooleanდიახFalse when the public MX lookup failed. A failed lookup is never read as "action needed".
mx_okbooleanდიახEvery live MX host is one this preset publishes, and there is at least one.
action_neededbooleanდიახ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_recordsobject[]დიახThe exact records to publish, as our preset would write them into a zone we host.

შეცდომები, რომლებიც ამ ენდპოინტს შეუძლია დააბრუნოს

401 · 403 · 404 · 409 · 422 · 429