POST /v1/mail/services
Set email up on a domain.
Hitelesítés
Küldjön egy API-kulcsot bearer tokenként. A kulcsnak rendelkeznie kell a(z) mail.manage jogosultsággal; az ezzel nem rendelkező kulcsok esetén a rendszer 403-as hibát ad vissza 404 helyett.
A szervezet azonosítójának helye
Ez a végpont a org_id mezőt várja a JSON törzsben.
A szervezeted azonosítója a vezérlőpult API-kulcsok képernyőjén található, közvetlenül a kulcs mellett. Ez ugyanaz az azonosító minden indított hívásban.
Próbálja ki
Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.
curl -X POST https://api.zinndigital.com/v1/mail/services \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "fqdn": <string> }'Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban
Részletek
Registers the email service and requests its provisioning. Returns 201 with the service pending: creating the backend account and publishing the mail DNS is a durable Temporal workflow (CLAUDE.md §2.9), so poll status or subscribe to mail.provisioned / mail.provisioning_failed. ⛔ Provisioning refuses to overwrite existing mail. If the domain's apex already carries a foreign MX, or its zone cannot be read at all, the service ends failed rather than replacing records that are delivering someone's live email. That refusal is not retried — it is a decision about the customer's own domain. Requires mail.manage. Fails 409 when the domain already has an email service, and 422 when the plan does not include mailboxes.
Kérés törzse
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
org_id | Uuid | Nem | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
fqdn | string | Igen | The domain to set email up on. |
domain_id | Uuid | null | Nem | — |
provider | MailProvider | Nem | Who runs the mailboxes for this domain. Defaults to zinn — our own email. google_workspace and microsoft_365 publish that provider's own MX, SPF, DKIM and autodiscover… |
provider_config | MailProviderConfig | null | Nem | The custom provider's values. Required in effect for custom; ignored otherwise. |
Válasz
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
id | Uuid | Igen | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
fqdn | string | Igen | The domain the mailboxes are on. |
provider_config | MailProviderConfig | null | Nem | The custom provider's declared values, served back so the domain screen can show and edit what was declared. null on every other provider, whose values are documented and… |
site | MailServiceSite | null | Nem | The site currently serving this domain, or null when no site does. Derived from the hostname, never stored: mail attaches to a domain and a domain outlives the site on it,… |
mailbox_provisioning | MailboxProvisioning | Igen | Whether we pre-create a starter mailbox on this domain. managed — we make one when the domain is provisioned (the Footprint-Free/PBN line and our own fleet); self_service… |
mail_only | boolean | Igen | This domain uses us for mail and nothing else — an active mail service on a hostname no website of ours serves. Published as one server-side answer because more than one… |
domain_id | Uuid | null | Nem | The registered domain this serves, when we hold the registration. |
status | MailServiceStatus | Igen | A mail service's lifecycle state. |
provider | MailProvider | Igen | Which provider serves a domain's mail. custom is the reseller's own provider (W40-MAIL, owner ruling 2026-09-06): a white-label reseller sells mail they buy elsewhere,… |
mailbox_quota_mb | integer | Igen | Size of each mailbox in MB, captured when the service was created. |
mailbox_limit | integer | Igen | Mailboxes allowed on this domain; -1 is uncapped. Captured when the service was created; a later downgrade is enforced against the live plan as well, so the number actually… |
mailboxes_used | integer | Igen | How many mailboxes currently consume the allowance. |
dns_applied_at | object | Nem | When the mail DNS was last published. null means never — mailboxes that exist but receive nothing, which is the one state a customer must be told about. |
created_at | string | Igen | — |
Hibák, amelyeket ez a végpont visszaadhattatlan
401 · 403 · 409 · 422 · 429