mail

PUT `/v1/mail/reseller-brand`

Set the mail hostnames this reseller's mail carries.

אימות

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

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

נסה זאת

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

curl -X PUT https://api.zinndigital.com/v1/mail/reseller-brand \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "mx_hosts": <string[]>, "spf_include": <string>, "autodiscover_host": <string>, "imap_host": <string>, "smtp_host": <string>, "webmail_host": <string> }'

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

פרטים

Requires mail.manage. Every field is a public hostname — there is no credential here, because the relay authenticates the mailbox rather than the brand. ⭐ This is what makes hosted mail sellable by a white-label reseller. With their own mx1. / imap. / smtp. / webmail. names in front of the relay, nothing published on a client's zone and nothing handed to a client's mail app carries the platform's name — so the product can be offered without the leak that previously required withholding it. ⛔ A partially-filled brand is saved and does not enable anything. configured is all-or-nothing: a brand with an MX and no webmail host would publish the reseller's MX and then send their client to somebody else's webmail, which is the leak arriving through the mechanism built to close it.

גוף הבקשה

שם	סוג	נדרש	מה זה
`name`	`string`	לא	What the reseller calls this brand, for their own screens.
`mx_hosts`	`string[]`	כן	Apex MX targets in priority order, on the reseller's own domain, pointed at the relay's addresses. Their names — an A record they publish, never a CNAME to ours, which would put…
`spf_include`	`string`	כן	The domain in the reseller's `v=spf1 include:…`. A delegation, so it must be a name whose SPF record they control and which in turn includes our sender list.
`autodiscover_host`	`string`	כן	—
`imap_host`	`string`	כן	—
`smtp_host`	`string`	כן	—
`webmail_host`	`string`	כן	Where the reseller's client's browser goes to read mail — the single most visible name in the whole product.

תשובה

שם	סוג	נדרש	מה זה
`name`	`string`	לא	What the reseller calls this brand, for their own screens.
`mx_hosts`	`string[]`	כן	Apex MX targets in priority order, on the reseller's own domain, pointed at the relay's addresses. Their names — an A record they publish, never a CNAME to ours, which would put…
`spf_include`	`string`	כן	The domain in the reseller's `v=spf1 include:…`. A delegation, so it must be a name whose SPF record they control and which in turn includes our sender list.
`autodiscover_host`	`string`	כן	—
`imap_host`	`string`	כן	—
`smtp_host`	`string`	כן	—
`webmail_host`	`string`	כן	Where the reseller's client's browser goes to read mail — the single most visible name in the whole product.
`configured`	`boolean`	כן	Whether every hostname the preset needs has been supplied. All-or-nothing: a half-set would publish the reseller's MX beside the platform's SPF include, which is a leak and a…
`verified_at`	`string`	לא	When these names were last confirmed to resolve to the relay.

שגיאות שנקודה קצה זו עשויה להחזיר

401 · 403 · 422 · 429

PUT /v1/mail/reseller-brand