Britive platform release 2026.09.02 is now live in production.

Save branding (draft)

Prev Next
Patch
/api/settings/branding

Upserts branding assets and metadata as a draft. Applied branding unaffected until POST /api/settings/branding/apply. Admin only.

Security
HTTP
Type bearer
Body parameters
object
settings
string (json) Required

JSON-serialised BrandingRequest.

lightLogo
string (binary)

Light logo (PNG or SVG, max 1.5 MB).

darkLogo
string (binary)

Dark logo (PNG or SVG, max 1.5 MB). Requires a light logo to be present.

favicon
string (binary)

Favicon (SVG, PNG, or ICO, max 1 MB).

rightPanelImage
string (binary)

Right-panel background image (PNG or SVG, max 2 MB).

Responses
200

Saved successfully — returns the saved branding record

Expand All
object
brandText
string

Tenant brand/welcome text.

hideBuiltInThemes
boolean

Whether the tenant's built-in themes are hidden.

isApplied
boolean

Whether this is the currently applied (published) branding.

isDark
boolean

Whether the tenant default theme is dark mode. Derived from pab_tenant_theme; not stored on the branding record.

lightLogoUrl
string

Cache-busting serve URL for the light logo. Null if not uploaded.

darkLogoUrl
string

Cache-busting serve URL for the dark logo. Falls back to lightLogoUrl if no dark logo uploaded.

faviconUrl
string

Cache-busting serve URL for the favicon. Null if not uploaded.

rightSidePanel
object (RightSidePanelDto)

Tenant-wide right-side panel configuration, independent of any individual theme.

type
string

Panel mode — default, solid color, or custom image.

Valid values[ "BRITIVE_DEFAULT", "SOLID_COLOR", "IMAGE" ]
Default"BRITIVE_DEFAULT"
color
string

HEX color code. Required when type is SOLID_COLOR. Null/omitted otherwise.

imageUrl
string

Cache-busting serve URL for the panel image. Not mode-dependent (single image, unlike the logo). Null unless type is IMAGE.

400

Validation error

403

Forbidden