身份验证
请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 reseller.manage 权限；缺少该权限的密钥将被拒绝并返回 403 状态码，而非 404。
您的组织 ID 应填在此处
此端点将 org_id 作为查询参数。不填则调用涵盖您的整个租户子树；发送该参数则将调用范围缩小到一个组织。
您的组织ID位于控制面板的API密钥屏幕上，就在密钥本身的旁边。这是您在每次调用时使用的相同ID。
免费试用
将尖括号中的内容替换为您自己的值，并将键占位符替换为您仪表板中的一个键。
curl -X PUT https://api.zinndigital.com/v1/reseller/brand \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "name": <string> }'已登录？您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥，并针对实时 API 运行请求，以便您查看实际的响应。 在 API 控制台中打开此端点
详细信息
Creates or updates your brand. Requires reseller.manage — reading your brand is a view permission; changing what every one of your clients sees is not. ⛔ This endpoint is why white-label was unreachable until 2026-08-16. The resolver, the entitlement gate, the org-tree walk, the e-mail path and the panel painting were all built and correct, and nothing anywhere could create the row they all read — Brand held zero rows across the estate. ⛔ panel_hostname, sending_domain and sending_domain_verified are refused here, with a sentence saying why, rather than ignored. All three are facts about the outside world this endpoint cannot establish: a hostname nobody serves is a link to nowhere, an unverified sending domain does not deliver, and a verified flag a customer can set is a wish rather than a verification. Refused with 422 when white-label is not on your plan — storing a brand the resolver would decline to serve is configuration that silently does nothing.
参数
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
org_id (query) | Uuid | 否 | The organization this call acts on. Optional for a caller with exactly one direct membership; required for anyone with more than one — which is every reseller and every agency… |
请求正文
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
name | string | 是 | What your clients are told they are using. Never blank. |
primary_colour | string | 否 | — |
support_url | string | 否 | — |
status_url | string | 否 | — |
palette | object | 否 | Named colour tokens, hex values only. An unrecognised token is a 422 naming it, not a silent drop — a field that is ignored is how somebody comes to believe the platform is… |
font_source | string<catalogue, google, > | 否 | — |
font_key | string | 否 | — |
font_google_family | string | 否 | Install it with POST /v1/reseller/brand/font first — this field selects a family we already hold, and setting it alone would name a stylesheet with nothing behind it. |
nav_position | string<side, top, > | 否 | — |
density | string<comfortable, compact, > | 否 | — |
corner_radius | string<soft, square, > | 否 | — |
colour_scheme | string<system, light, dark, > | 否 | — |
favicon_sha256 | string | 否 | — |
email_logo_sha256 | string | 否 | — |
dns_nameservers | string[] | 否 | Your own nameservers. At least two, or none — a registrar refuses a single one, and refusing it here with a sentence is better than at the registrar with a code. |
响应
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
configured | boolean | 是 | Whether a brand row exists yet. False renders an empty form, not a 404. |
entitled | boolean | 是 | Whether white-label is on this org's plan at all. |
name | string | 是 | — |
logo_url | string | 是 | — |
primary_colour | string | 是 | — |
support_url | string | 是 | — |
status_url | string | 是 | — |
panel_hostname | string | 是 | Read-only here — provisioned on /v1/reseller/brand/panel-hostname, because a hostname you merely typed is a link to nowhere on every client's screen. |
panel_hostname_active | boolean | 是 | Whether the edge is actually serving it. ⛔ Measured, not the edge's status word: a custom hostname can be active with a valid certificate and still answer 522, so the engine… |
panel_hostname_status | string | 是 | The edge's own status word, for display. Never branch on it. |
panel_hostname_records | BrandDnsRecord[] | 是 | — |
sending_domain | string | 是 | Read-only here — provisioned on /v1/reseller/brand/sending-domain, because an unverified domain does not deliver. |
sending_domain_verified | boolean | 是 | Read-only. The mail provider's answer, not a setting. |
sending_domain_status | string | 是 | The provider's own status word, for display. Never branch on it. |
sending_domain_records | BrandDnsRecord[] | 是 | — |
palette | object | 否 | Named design-system colour tokens, {token: "#rrggbb"}, over the closed set in palette_tokens. ⛔ Hex only, and that is a security boundary rather than a formatting rule: a CSS… |
font_source | string<catalogue, google, > | 否 | catalogue for one of font_catalogue, google for a family we self-host. |
font_key | string | 否 | The catalogue key when font_source is catalogue. |
font_google_family | string | 否 | A Google family NAME, never a URL. ⛔ We fetch the family once, server-side, and serve the woff2 files from our own origin — so your clients never make a request to Google and… |
nav_position | string<side, top, > | 否 | — |
density | string<comfortable, compact, > | 否 | — |
corner_radius | string<soft, square, > | 否 | — |
colour_scheme | string<system, light, dark, > | 否 | The scheme a client's first visit lands on. ⛔ A default, never a lock — the panel's own theme toggle still works, because removing a visitor's dark mode is an accessibility… |
favicon_sha256 | string | 否 | A favicon distinct from the panel logo. Upload it with POST /v1/branding/logo and purpose=favicon. Empty falls back to the logo — a 32px render of a wordmark beats somebody… |
favicon_url | string | 否 | — |
email_logo_sha256 | string | 否 | The mark used in transactional mail (purpose=email). Separate because the constraints differ: mail clients render on a light background whatever the reader's theme, block SVG,… |
email_logo_url | string | 否 | — |
dns_nameservers | string[] | 否 | Your own authoritative nameservers, so a client typing them into a registrar never reads ours. Empty means ours. ⛔ At least two, or none — registrars refuse a single… |
font_catalogue | object[] | 否 | The typefaces you may pick, served with the value so a new one appears in your picker on deploy rather than when somebody remembers to update the app too. |
layout_options | object | 否 | The allowed values for each layout choice, keyed by field name. |
palette_tokens | string[] | 否 | The colour tokens palette may name. |
accent_contrast | BrandAccentContrast | 否 | How readable your accent colour is, and the ink we will paint on it. ⚠️ Reported, never enforced. A legitimate corporate colour can be mid-grey, and refusing to save it would… |
此端点可能返回的错误
401 · 403 · 404 · 422 · 429