Update the authenticated brand's profile (POL-716).

PATCH

/brands/me

• Production
• Staging
• Local dev

Accepts any subset of the allow-listed fields (name, displayName, description, avatarUrl, locationCity, locationState). Omitted fields are left untouched; explicit null clears a nullable field. Slug and theme changes are NOT allowed via this surface — use the admin tRPC mutation for slug and PATCH /brands/me/theme for theme.

Authorizations

• bearerAuth

Parameters

Header Parameters

X-Polst-Idempotency-Key

required

string

>= 8 characters <= 128 characters

Idempotency key, 8–128 URL-safe chars.

Request Body ^required

object

name

string

>= 1 characters <= 120 characters

displayName

Any of:

string

string

>= 1 characters <= 120 characters

null

null

description

Any of:

string

string

<= 2000 characters

null

null

avatarUrl

Any of:

string

string format: uri

null

null

locationCity

Any of:

string

string

<= 120 characters

null

null

locationState

Any of:

string

string

<= 120 characters

null

null

Responses

200

Updated brand profile.

object

data

required

object

slug

required

string

>= 1 characters

name

required

string

>= 1 characters

displayName

required

Any of:

string

string

null

null

description

required

Any of:

string

string

null

null

avatarUrl

required

Any of:

string

string

null

null

location

required

Any of:

string

string

null

null

theme

required

object

accent

required

Any of:

string

string

/^#([0-9a-f]{6}|[0-9a-f]{8})$/

null

null

background

required

Any of:

string

string

/^#([0-9a-f]{6}|[0-9a-f]{8})$/

null

null

foreground

required

Any of:

string

string

/^#([0-9a-f]{6}|[0-9a-f]{8})$/

null

null

radius

required

string

Allowed values: NONE SM MD LG FULL

density

required

string

Allowed values: COMPACT COMFORTABLE

fontStack

required

string

Allowed values: SYSTEM SERIF MONO BRAND

fontBrandUrl

required

Any of:

string

string

<= 2048 characters

null

null

logoLightUrl

required

Any of:

string

string

<= 2048 characters

null

null

logoDarkUrl

required

Any of:

string

string

<= 2048 characters

null

null

faviconUrl

required

Any of:

string

string

<= 2048 characters

null

null

hideWatermark

required

boolean

customCss

required

Any of:

string

string

<= 4096 characters

null

null

version

required

integer

<= 9007199254740991

titleColor

required

Any of:

string

string

/^#([0-9a-f]{6}|[0-9a-f]{8})$/

null

null

titleSize

required

Any of:

integer

integer

>= 10 <= 96

null

null

titleWeight

required

Any of:

integer

integer

>= 100 <= 900

null

null

titlePlacement

required

string

Allowed values: ABOVE BELOW HIDDEN

labelColor

required

Any of:

string

string

/^#([0-9a-f]{6}|[0-9a-f]{8})$/

null

null

labelSize

required

Any of:

integer

integer

>= 10 <= 72

null

null

labelPlacement

required

string

Allowed values: HEADER OVERLAID BELOW HIDDEN

labelAlign

required

string

Allowed values: LEFT CENTER

headerFill

required

Any of:

string

string

/^#([0-9a-f]{6}|[0-9a-f]{8})$/

null

null

orBadgeBg

required

Any of:

string

string

/^#([0-9a-f]{6}|[0-9a-f]{8})$/

null

null

orBadgeFg

required

Any of:

string

string

/^#([0-9a-f]{6}|[0-9a-f]{8})$/

null

null

orBadgeDiameter

required

Any of:

integer

integer

>= 24 <= 96

null

null

imageRatio

required

Any of:

number

number

>= 0.25 <= 4

null

null

elevation

required

string

Allowed values: FLAT LIFTED

brandId

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

scopes

required

Array<string>

400

Missing idempotency key.

401

Missing or invalid bearer token.

403

Bearer token lacks manage scope or brand context.

404

Brand not found.

422

Request body failed validation (unknown or invalid fields).