Skip to main content
PATCH
Update Branding

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

branding_uuid
string
required

Body

application/json

The only editable part of a branding: which one the company applies by default.

A branding itself is created and designed in the interface — the API neither creates, edits nor deletes one. label and everything behind it are therefore read-only and rejected if sent, rather than ignored.

is_default
boolean | null

Makes this branding the company's default, demoting the previous one in the same operation. A company always keeps exactly one default, so setting it to false on the branding that currently is the default is refused: promote another one instead.

Response

Successful Response

A visual identity of the company, identified by an opaque id.

A branding decides how the company's documents are rendered. The API exposes what names one and which one applies by default; the logo and the layout settings behind it belong to the interface and are never returned.

id
string
required

Opaque unique identifier of the branding.

label
string | null
required

Name given to the branding by the company.

is_default
boolean
required

true when this is the branding applied to the company's documents.