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

contact_email?||

Email address shown for Trust Center contact requests. Send an empty string or null to clear it.

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

Enabled content locale to update. If omitted, the tenant default locale is updated.

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

email_footer?string

Optional transactional email legal footer. Default-locale writes update the tenant record; non-default-locale writes update that locale's tenant translation. Reads fall back to the default-locale tenant footer when the selected translation is missing or blank. Input is trimmed server-side. Supports multiline text, bold, italic, and http/https/mailto Markdown links; headings, lists, tables, raw HTML, images, and reference links render as plain text or are stripped.

Lengthlength <= 4000

footer_links?array<>

Footer navigation links

faqs?array<>

Complete FAQ list for the selected locale. Default-locale writes update the tenant record. Non-default locale writes update the tenant translation for that locale.

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": "string"  }}

How is this guide?

Authorization

Request Body

Response Body

200application/json

400application/json

401

403

500

`application/json`

`application/json`