agency-board

PUT `/v1/boards/brand`

Set the branding your shared boards carry.

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

Пошаљите API кључ као bearer токен. Кључ мора имати дозволу agency.board.manage; кључ без ње се одбија уз 403, а не 404.

Где се уноси ID ваше организације

Ова крајња тачка прихвата org_id као параметар упита. Изоставите га и позив ће обухватити цело подстабло вашег закупа; пошаљите га да бисте сузили позив на једну организацију.

Идентификатор ваше организације се налази на екрану са API кључевима на вашој контролној табли, поред самог кључа. То је исти идентификатор у сваком позиву који упутите.

Испробајте

Замените све што је у угластим заградама сопственим вредностима, а чувар места кључа кључем са своје контролне табле.

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

Пријављени сте? API конзола на вашој контролној табли попуњава ваш прави id организације и ваш сопствени кључ, и покреће захтев према живом API-ју како бисте могли да видите стварни одговор. Отворите ову крајњу тачку у API конзоли

Детаљи

Creates or updates the identity on your board share links. Requires agency.board.manage — reading it is a view permission; changing what everyone you have shared a board with sees is not. ⛔ This endpoint is why Boards branding bought nothing until 2026-09-15. The resolver, the entitlement and the shared-board payload were all built and correct, and the only surface that could create the brand row required reseller.manage — which a Boards customer has no reason to hold. ⛔ Deliberately narrower than PUT /v1/reseller/brand. panel_hostname and sending_domain are refused here by name, as they are there: both are agency capabilities a Boards plan does not include, and both cost real money to provision. Refused with 422 when branding 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…

Тело захтева

Назив	Тип	Обавезно	Шта је ово
`name`	`string`	Да	What your clients call you. Shown on every share link.
`primary_colour`	`string`	Не	A hex value such as `#2b8a3e`. Empty means use ours.

Одговор

Назив	Тип	Обавезно	Шта је ово
`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 · 422 · 429

PUT /v1/boards/brand