Аутентификация

Отправьте ключ 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 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