அங்கீகாரம்
பியரர் டோக்கனாக (bearer token) ஒரு API விசையை அனுப்பவும். அந்த விசை reseller.manage அனுமதியைக் கொண்டிருக்க வேண்டும்; அது இல்லாத விசை 404 அல்ல, 403 குறியீட்டுடன் மறுக்கப்படும்.
உங்கள் அமைப்பு ஐடி எங்கு செல்ல வேண்டும்
இந்த எண்ட் பாயிண்ட் org_id என்பதை வினவல் அளபுருவாக (query parameter) எடுத்துக்கொள்கிறது. இதை விட்டுவிட்டால், அழைப்பு உங்கள் முழு டெனன்சி துணை மரத்தையும் (tenancy subtree) உள்ளடக்கும்; ஒரு நிறுவனத்திற்கு மட்டுமே அழைப்பைக் சுருக்க இதை அனுப்பவும்.
உங்கள் நிறுவன ஐடி உங்கள் டாஷ்போர்டில் உள்ள API விசைகள் திரையில், விசைக்கு அருகிலேயே உள்ளது. நீங்கள் செய்யும் ஒவ்வொரு அழைப்பிலும் இதுவே ஒரே ஐடி ஆகும்.
முயன்று பார்
கோண அடைப்புக்குறிகளில் உள்ள எதையும் உங்கள் சொந்த மதிப்புகளுடன் மாற்றவும், மேலும் விசை பிளேஸ்ஹோல்டரை உங்கள் டாஷ்போர்டில் உள்ள விசையுடன் மாற்றவும்.
curl -X PUT https://api.zinndigital.com/v1/reseller/brand \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "name": <string> }'உள்நுழைந்துள்ளீர்களா? உங்கள் டேஷ்போர்டில் உள்ள ஏபிஐ கன்சோல் உங்கள் உண்மையான நிறுவன ஐடி மற்றும் உங்கள் சொந்த சாவியை நிரப்புகிறது, மேலும் நேரலை ஏபிஐக்கு எதிராக கோரிக்கையை இயக்குகிறது, இதனால் நீங்கள் உண்மையான பதிலைக் காண முடியும். இந்த எண்ட்மார்க்கை ஏபிஐ கன்சோலில் திறக்கவும்
விவரங்கள்
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