Update a branding policy

put

https://{tenant}/admin/api/v1/brands/{id}

You can update a branding policy by calling this endpoint.

REQUIRED API PERMISSION
write:config_brand

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Body Params

additionalContents

object

additionalScripts

object

additionalTexts

object

backgroundColor

string

required

Represented in a hexadecimal format, optionally extended with an alpha channel.

brandName

string

required

length between 2 and 48

string

css

object

description

string

length between 0 and 1024

faviconUrl

string

required

logoInFooter

boolean

Defaults to false

logoUrl

string

name

string

required

length between 3 and 64

policyTag

string

Must be an existing policy tag name

primaryColor

string

required

Represented in a hexadecimal format, optionally extended with an alpha channel.

privacyPolicyUrl

string

length between 10 and 1024

siteTermsUrl

string

length between 10 and 1024

supportText

string

length between 1 and 1024

Headers

string

enum

Defaults to application/problem+json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

*/*

application/problem+json

200OK

400Bad Request

401Unauthorized

403Forbidden

404Not Found

409Conflict