Update Branding
Make this branding the one the company’s documents are rendered with.
is_default is the only thing the API changes about a branding: the label, the logo and
the layout are designed in the interface. Setting it to true promotes this branding and
demotes the previous default in the same transaction, on the locked row.
The company always keeps exactly one default, so false is refused on the branding that
currently is it (422 default_branding_required) — promote another one instead. Asking
for the state a branding is already in changes nothing and is not an error.
In sandbox mode the body is validated exactly as in live mode but nothing is stored: the
response reflects the change, and the next GET returns the branding untouched.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
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.
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.