Skip to main content
PUT
Replace workspace branding

Authorizations

Authorization
string
header
required

Your API key in Authorization: Bearer <key>. Use vk_test_… keys against the sandbox and vk_live_… keys against production.

Body

application/json

Workspace Branding content.

primaryColor
string | null
required

Primary colour #rrggbb.

Pattern: ^#[0-9a-f]{6}$
secondaryColor
string | null
required

Secondary colour.

Pattern: ^#[0-9a-f]{6}$
backgroundColor
string | null
required

Background colour.

Pattern: ^#[0-9a-f]{6}$
surfaceColor
string | null
required

Surface colour.

Pattern: ^#[0-9a-f]{6}$
textColor
string | null
required

Text colour (AA contrast on the background).

Pattern: ^#[0-9a-f]{6}$
accentColor
string | null
required

Accent colour.

Pattern: ^#[0-9a-f]{6}$
buttonColor
string | null
required

Button colour.

Pattern: ^#[0-9a-f]{6}$
buttonTextColor
string | null
required

Button text colour (AA contrast on the button).

Pattern: ^#[0-9a-f]{6}$
buttonBorderColor
string | null
required

Button border colour.

Pattern: ^#[0-9a-f]{6}$
logoAssetId
integer<uint64> | null
required

Logo asset.

Required range: 0 <= x <= 18446744073709552000
logoDarkAssetId
integer<uint64> | null
required

Logo for dark backgrounds.

Required range: 0 <= x <= 18446744073709552000
iconAssetId
integer<uint64> | null
required

Icon asset.

Required range: 0 <= x <= 18446744073709552000
heroImageAssetId
integer<uint64> | null
required

Hero image asset.

Required range: 0 <= x <= 18446744073709552000
faviconAssetId
integer<uint64> | null
required

Favicon asset.

Required range: 0 <= x <= 18446744073709552000
emailLogoAssetId
integer<uint64> | null
required

Logo used in emails.

Required range: 0 <= x <= 18446744073709552000
fontFamily
enum<string> | null
required

Font family. Treat as an open set: new values may be added.

Available options:
inter,
roboto,
open-sans,
lato,
source-sans-3,
system,
null
cornerRadius
enum<string> | null
required

Corner radius. Treat as an open set: new values may be added.

Available options:
none,
sm,
md,
lg,
full,
null
extensions
object | null
required

Free-form extension values (keys x-*); scanned like every text.

Example:
landing
object | null
required

Consumer landing block; null until set.

Response

Saved: every later save.

Single-object envelope around a WorkspaceBranding.

data
object
required

Workspace Branding: the look of your dashboards and, for consumers, your landing pages and OTP emails.