reseller

PUT /v1/reseller/brand

Set the identity your clients see.

Toate punctele finale reseller

Autentificare

Trimiteți o cheie API ca token de tip bearer. Cheia trebuie să aibă permisiunea reseller.manage; o cheie care nu o are va fi respinsă cu 403, nu 404.

Unde merge ID-ul organizației tale

Acest punct final acceptă org_id ca parametru de interogare. Omiteți-l și apelul va acoperi întregul subarbore al chiriașului dvs.; trimiteți-l pentru a restrânge apelul la o singură organizație.

ID-ul organizației tale se află pe ecranul cheilor API din panoul de control, lângă cheia însăși. Este același ID în fiecare apel pe care îl faci.

Încearcă

Înlocuiți tot ce se află între paranteze unghiulare cu propriile valori și substituentul cheie cu o cheie din tabloul de bord.

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

Autentificat? Consola API din panoul de control îți completează ID-ul real al organizației și propria cheie și rulează cererea în API-ul live, astfel încât să poți vedea răspunsul efectiv. Deschideți acest punct final în consola API

Detalii

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.

Parametri

NumeTipObligatoriuCe este
org_id (query)UuidNuThe 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…

Corp cerere

NumeTipObligatoriuCe este
namestringDaWhat your clients are told they are using. Never blank.
primary_colourstringNu
support_urlstringNu
status_urlstringNu
paletteobjectNuNamed 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, >Nu
font_keystringNu
font_google_familystringNuInstall 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, >Nu
densitystring<comfortable, compact, >Nu
corner_radiusstring<soft, square, >Nu
colour_schemestring<system, light, dark, >Nu
favicon_sha256stringNu
email_logo_sha256stringNu
dns_nameserversstring[]NuYour 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.

Răspuns

NumeTipObligatoriuCe este
configuredbooleanDaWhether a brand row exists yet. False renders an empty form, not a 404.
entitledbooleanDaWhether white-label is on this org's plan at all.
namestringDa
logo_urlstringDa
primary_colourstringDa
support_urlstringDa
status_urlstringDa
panel_hostnamestringDaRead-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_activebooleanDaWhether 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_statusstringDaThe edge's own status word, for display. Never branch on it.
panel_hostname_recordsBrandDnsRecord[]Da
sending_domainstringDaRead-only here — provisioned on `/v1/reseller/brand/sending-domain`, because an unverified domain does not deliver.
sending_domain_verifiedbooleanDaRead-only. The mail provider's answer, not a setting.
sending_domain_statusstringDaThe provider's own status word, for display. Never branch on it.
sending_domain_recordsBrandDnsRecord[]Da
paletteobjectNuNamed 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, >Nu`catalogue` for one of `font_catalogue`, `google` for a family we self-host.
font_keystringNuThe catalogue key when `font_source` is `catalogue`.
font_google_familystringNuA 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, >Nu
densitystring<comfortable, compact, >Nu
corner_radiusstring<soft, square, >Nu
colour_schemestring<system, light, dark, >NuThe 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_sha256stringNuA 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_urlstringNu
email_logo_sha256stringNuThe 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_urlstringNu
dns_nameserversstring[]NuYour **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[]NuThe 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_optionsobjectNuThe allowed values for each layout choice, keyed by field name.
palette_tokensstring[]NuThe colour tokens `palette` may name.
accent_contrastBrandAccentContrastNuHow 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…

Erori pe care le poate returna acest punct final

401 · 403 · 404 · 422 · 429