PUT /v1/mail/reseller-brand
Set the mail hostnames this reseller's mail carries.
인증
Bearer 토큰으로 API 키를 전송하세요. 키는 반드시 mail.manage 권한을 가지고 있어야 하며, 권한이 없는 키는 404가 아닌 403으로 거부됩니다.
이 엔드포인트는 조직 ID를 받지 않습니다. 사용자의 키가 이미 속한 조직을 식별하며, 응답은 해당 조직으로 한정됩니다.
무료 체험하기
대괄호 안에 있는 모든 내용을 사용자 지정 값으로 바꾸고, 키 플레이스홀더는 대시보드의 키로 바꾸세요.
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 콘솔이 실제 조직 ID와 본인의 키를 자동으로 채우고 라이브 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