agency-board
GET /v1/boards/brand
The branding your shared boards carry.
Аутентификација
Пошаљите API кључ као bearer токен. Кључ мора имати дозволу agency.board.view; кључ без ње се одбија уз 403, а не 404.
Где се уноси ID ваше организације
Ова крајња тачка прихвата org_id као параметар упита. Изоставите га и позив ће обухватити цело подстабло вашег закупа; пошаљите га да бисте сузили позив на једну организацију.
Идентификатор ваше организације се налази на екрану са API кључевима на вашој контролној табли, поред самог кључа. То је исти идентификатор у сваком позиву који упутите.
Испробајте
Замените све што је у угластим заградама сопственим вредностима, а чувар места кључа кључем са своје контролне табле.
curl -X GET https://api.zinndigital.com/v1/boards/brand \
-H "Authorization: Bearer zdk_live_…"Пријављени сте? API конзола на вашој контролној табли попуњава ваш прави id организације и ваш сопствени кључ, и покреће захтев према живом API-ју како бисте могли да видите стварни одговор. Отворите ову крајњу тачку у API конзоли
Детаљи
The name, mark and colour that people opening one of your board share links see — instead of ours. Requires agency.board.view. ⛔ A brand you have not set up yet is a 200 with configured: false, never a 404: the screen renders an empty form either way. ⛔ entitled is computed on the shared-board surface specifically. Boards Business sells branding for shared boards and not platform-wide white-label, so this answers a narrower question than GET /v1/reseller/brand's field of the same name — and answering the wider one here would tell a paying customer their branding 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… |
Одговор
| Назив | Тип | Обавезно | Шта је ово |
|---|---|---|---|
configured | boolean | Да | Whether a brand row exists yet. False renders an empty form, not a 404. |
entitled | boolean | Да | Whether branding on shared boards is on this org's plan. ⛔ Computed on the shared-board surface, so a Boards Business org reads true here while holding no platform-wide… |
surface | string | Да | Which branding surface this answer is about. Always shared_board. |
name | string | Да | — |
logo_url | string | Да | Where the stored mark is served from, or empty. Read-only — the logo is an upload. |
primary_colour | string | Да | — |
Грешке које ова крајња тачка може вратити
401 · 403 · 404 · 429