reseller

PUT /v1/reseller/brand

Set the identity your clients see.

Усі кінцеві точки reseller

Автентифікація

Надішліть ключ API як маркер носія (bearer token). Ключ повинен мати дозвіл reseller.manage; ключ без нього відхиляється з кодом 403, а не 404.

Де вказується ідентифікатор вашої організації

Цей ендпоїнт приймає org_id як параметр запиту. Залиште його порожнім, і виклик охопить увесь ваше дерево орендарів; надішліть його, щоб звузити виклик до однієї організації.

Ідентифікатор вашої організації знаходиться на екрані API-ключів у вашій панелі керування, поруч із самим ключем. Це той самий ідентифікатор у кожному вашому запиті.

Спробувати

Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.

curl -X PUT https://api.zinndigital.com/v1/reseller/brand \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "name": <string> }'

Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого 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 agen…

Тіло запиту

НазваТипОбов'язковеЩо це таке
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 engi…
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 CS…
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 th…
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 nameser…
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 woul…

Помилки, які може повертати ця кінцева точка

401 · 403 · 404 · 422 · 429