احراز هویت
یک کلید API را به عنوان یک توکن حامل ارسال کنید. این کلید باید دارای مجوز 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… |
بدنه درخواست
| نام | نوع | الزامی | چیست |
|---|---|---|---|
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 engi… |
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 CS… |
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 th… |
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 nameser… |
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 woul… |
خطاهایی که این نقطه پایانی میتواند برگرداند
401 · 403 · 404 · 422 · 429