Skip to main content
PATCH
Update the Brand Book

Authorizations

Authorization
string
header
required

Organization-scoped bearer credential: a customer API key (1club_sk_live_...) or an MCP OAuth access token.

Body

application/json
accentColor
string | null
Example:

"#c2410c"

keepBrandColors
boolean
toneOfVoice
enum<string> | null
Available options:
professional,
friendly,
casual,
formal
guidelines
string | null
Maximum string length: 4000

Response

The Brand Book after the change

primaryColor
string | null
darkPrimaryColor
string | null
accentColor
string | null
headerColor
string | null
darkHeaderColor
string | null
backgroundColor
string | null
textColor
string | null
darkBackgroundColor
string | null
darkTextColor
string | null
logoUrl
string | null

The logo for light backgrounds

logoDarkUrl
string | null

The logo for dark backgrounds

logoAltText
string | null
iconUrl
string | null

The square Icon, for square and round frames such as avatars and app icons

faviconUrl
string | null
read-only

The Icon as a square PNG for browser tabs. Derived from iconUrl.

fontFamily
string | null
headingFontFamily
string | null
keepBrandColors
boolean

A template's look leaves the brand colours alone and the in-app assistants are told to. A theme write that names a colour still applies.

toneOfVoice
enum<string> | null
Available options:
professional,
friendly,
casual,
formal
guidelines
string | null

The organization's own writing guidelines: form of address, words to use or avoid, anything else. Line breaks are kept.

Maximum string length: 4000