reseller

PUT /v1/reseller/brand

Set the identity your clients see.

すべての reseller エンドポイント

すべての開発者向けドキュメント

認証

ベアラー トークンとして API キーを送信します。キーには reseller.manage 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。

組織 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…

リクエスト本文

名前タイプ必須これがその内容です
namestringはいWhat your clients are told they are using. Never blank.
primary_colourstringいいえ
support_urlstringいいえ
status_urlstringいいえ
paletteobjectいいえ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_sourcestring<catalogue, google, >いいえ
font_keystringいいえ
font_google_familystringいいえ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_positionstring<side, top, >いいえ
densitystring<comfortable, compact, >いいえ
corner_radiusstring<soft, square, >いいえ
colour_schemestring<system, light, dark, >いいえ
favicon_sha256stringいいえ
email_logo_sha256stringいいえ
dns_nameserversstring[]いいえ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.

返信

名前タイプ必須これがその内容です
configuredbooleanはいWhether a brand row exists yet. False renders an empty form, not a 404.
entitledbooleanはいWhether white-label is on this org's plan at all.
namestringはい
logo_urlstringはい
primary_colourstringはい
support_urlstringはい
status_urlstringはい
panel_hostnamestringはい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_activebooleanはい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_statusstringはいThe edge's own status word, for display. Never branch on it.
panel_hostname_recordsBrandDnsRecord[]はい
sending_domainstringはいRead-only here — provisioned on /v1/reseller/brand/sending-domain, because an unverified domain does not deliver.
sending_domain_verifiedbooleanはいRead-only. The mail provider's answer, not a setting.
sending_domain_statusstringはいThe provider's own status word, for display. Never branch on it.
sending_domain_recordsBrandDnsRecord[]はい
paletteobjectいいえ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_sourcestring<catalogue, google, >いいえcatalogue for one of font_catalogue, google for a family we self-host.
font_keystringいいえThe catalogue key when font_source is catalogue.
font_google_familystringいいえ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_positionstring<side, top, >いいえ
densitystring<comfortable, compact, >いいえ
corner_radiusstring<soft, square, >いいえ
colour_schemestring<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_sha256stringいいえ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_urlstringいいえ
email_logo_sha256stringいいえ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_urlstringいいえ
dns_nameserversstring[]いいえ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_catalogueobject[]いいえ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_optionsobjectいいえThe allowed values for each layout choice, keyed by field name.
palette_tokensstring[]いいえThe colour tokens palette may name.
accent_contrastBrandAccentContrastいいえ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