mail

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

Move a domain's email to a different provider.

ټول mail پای ټکي

ټول د پراختیا کونکي اسناد

تصدیق‌هویت

یو API کی د بیئرر ټوکن (bearer token) په توګه ولیکئ. کی باید د mail.manage اجازه ولري؛ له دې اجازې پرته کی د 404 پرځای د 403 په واسطه رد کیږي.

دا پای نقطه د سازمان هېڅ آی ډي نه اخلي. ستاسو کیلي مخکې تر مخکې هغه سازمان په ګوته کوي چې پورې اړه لري، او ځواب ورته محدود دی.

هڅه وکړئ

د انګلیسي په زاوي پنسونو کې هرڅه د خپلو ارزښتونو سره بدل کړئ، او د کلي ځای لرونکی ستاسو د ډشبورډ د کلي سره.

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

ننوتي یاست؟ ستاسو په ډشبورډ کې د API کنسول ستاسو د اصلي سازمان ID او ستاسو خپله کیلي ډکوي، او غوښتنه د ژوندی API په وړاندې پرمخ وړي ترڅو تاسو وکولی شئ اصلي ځواب وګورئ. دا پای ټکی (endpoint) د API په کنسول کې پرانیزئ

تفصیلات

Repoints this domain at another mail provider — our own email, Google Workspace or Microsoft 365 — and, when moving away from ours, destroys the mailboxes we were hosting for it. ⛔ Not the same as DELETE, and the difference is the post-condition. A delete ends with no mail service at all; a switch ends with a live one on the new provider, publishing that provider's records. Using the delete for this would leave the domain with no email a moment after the customer chose some. The order is the safety property: the DNS records are repointed FIRST, and the mailboxes destroyed second. The reverse loses mail — between a destroy and a repoint the MX still names mailboxes that no longer exist, and everything sent in that window bounces. Doing it this way costs a brief period in which both could receive, which is the harmless failure. confirm_fqdn — the domain typed back — is required when the switch destroys mailboxes we run, and ignored otherwise. Owner ruling 2026-08-14: type the domain, no grace period. The mailboxes and their contents are gone at the vendor the moment this runs. Switching to the provider a domain is already on is a no-op that returns the service, so a retry is idempotent. Requires mail.manage.

پارامترونه

نومډولاړیندا څه شی دی
mailServiceId (path)UuidهوEmail service ID (UUIDv7).

د غوښتنې بدن

نومډولاړیندا څه شی دی
providerMailProviderهو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,…
provider_configMailProviderConfig | nullنهRequired in effect when provider is custom (an empty MX list is refused); ignored otherwise. A customcustom call with different values is a re-declaration — the…
confirm_fqdnstringنهThe domain, typed back by the customer. Required when the switch destroys mailboxes we host — i.e. when moving away from zinn on a domain that has any — and ignored…

ځواب

نومډولاړیندا څه شی دی
idUuidهوUUIDv7 identifier — sortable by creation time (docs/02 §8).
fqdnstringهوThe domain the mailboxes are on.
provider_configMailProviderConfig | nullنه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…
siteMailServiceSite | nullنه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_provisioningMailboxProvisioningهو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_onlybooleanهو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_idUuid | nullنهThe registered domain this serves, when we hold the registration.
statusMailServiceStatusهوA mail service's lifecycle state.
providerMailProviderهو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_mbintegerهوSize of each mailbox in MB, captured when the service was created.
mailbox_limitintegerهو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_usedintegerهوHow many mailboxes currently consume the allowance.
dns_applied_atobjectنه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_atstringهو

تېروتنې چې دا پای ټکی یې بیرته راګرځولی شي

401 · 403 · 404 · 409 · 422 · 429 · 503