GET /v1/mail/reseller-brand
The mail hostnames this reseller's mail is published and served under.
身份验证
请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 mail.view 权限；缺少该权限的密钥将被拒绝并返回 403 状态码，而非 404。
您的组织 ID 应填在此处
此端点将 org_id 作为查询参数。不填则调用涵盖您的整个租户子树；发送该参数则将调用范围缩小到一个组织。
您的组织ID位于控制面板的API密钥屏幕上，就在密钥本身的旁边。这是您在每次调用时使用的相同ID。
免费试用
将尖括号中的内容替换为您自己的值，并将键占位符替换为您仪表板中的一个键。
curl -X GET https://api.zinndigital.com/v1/mail/reseller-brand \
-H "Authorization: Bearer zdk_live_…"已登录？您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥，并针对实时 API 运行请求，以便您查看实际的响应。 在 API 控制台中打开此端点
详细信息
Requires mail.view. An organization with no brand configured gets an empty one with configured: false rather than a 404 — the form is the same either way.
参数
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
org_id (query) | Uuid | 否 | The organization to read for; defaults to the caller's own when unambiguous. |
响应
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
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 · 429