mail

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

Move a domain's email to a different provider.

כל נקודות הקצה מסוג mail

כל תיעוד המפתחים

אימות

שלחו מפתח API כאסימון נושא (bearer token). על המפתח לכלול את הרשאה mail.manage; מפתח שאינו כולל אותה יידחה בסטטוס 403, ולא 404.

נקודת קצה זו אינה דורשת מזהה ארגון. המפתח שלך כבר מזהה את הארגון שאליו הוא שייך, והתגובה מוגבלת אליו בלבד.

נסה זאת

החלף כל דבר בסוגריים זוויתיים בערכים משלך, ואת מציין מיקום המפתח במפתח מלוח הבקרה שלך.

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 בלוח הבקרה שלך מזינה את מזהה הארגון האמיתי שלך ואת המפתח שלך, ומריצה את הבקשה מול ה-API הפיזי כך שתוכל לראות את התגובה בפועל. פתח נקודת קצה זו במסוף ה-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