Update brand settings

Update tenant brand settings including colors, fonts, text content, and footer configuration. Browse request parameters, authentication requirements,…

Update tenant brand settings including colors, fonts, text content, and footer configuration.

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

title*string

Trust center title

Length1 <= length

deployment_domains?string

Deployment domains configuration

primary_color*string

Primary brand color in hex format

Match^#[0-9a-fA-F]{6}$

background_color*string

Background color in hex format

Match^#[0-9a-fA-F]{6}$

text_color*string

Text color in hex format

Match^#[0-9a-fA-F]{6}$

font_family*string

Font family for the trust center

Length1 <= length

locale?string

Default Trust Center content locale.

Value in"en" | "de" | "fr" | "ja" | "ko" | "zh"

brand_extended?|

JSON field for advanced styling; accepts raw CSS string or an object with css (max 50,000 characters) and is sanitized server-side. Use cautiously to avoid breaking layout.

overview_text?string

Overview text displayed on the trust center

overview_text_2?string

Optional second column of overview content displayed alongside the primary overview

footer_text?string

Footer text

footer_links?array<>

Footer navigation links

Response Body

`application/json`

curl -X PATCH "https://example.com/api/v1/brand" \  -H "Content-Type: application/json" \  -d '{    "title": "Acme Trust Center",    "primary_color": "#007bff",    "background_color": "#ffffff",    "text_color": "#0f172a",    "font_family": "Inter, sans-serif"  }'

{
  "success": true,
  "data": {
    "message": "Brand settings updated."
  }
}

{
  "error": "Invalid input: primary_color: Invalid hex color format"
}

Empty

How is this guide?

Authorization

Request Body

Response Body

200application/json

400application/json

401

500

Invalid color format

Missing title

`application/json`

`application/json`