Skip to main content
PATCH
Change part of the Brand Kit

Authorizations

Authorization
string
header
required

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

Query Parameters

organizationId
string<uuid>

Body

application/json

Changes part of the kit and leaves the rest as it is. Only the keys that are sent change.

colors
object[]

The whole list of colors (it replaces the saved list).

Maximum array length: 24
fonts
object

The text roles to change; the roles that are left out keep their font.

spacing
object

The spacing and radius steps to change; the steps that are left out keep their value.

cornerRadius
integer

One corner radius in pixels for the whole kit; the small, medium and large radii are made from it. 0 gives square corners. A radius step sent in spacing wins over the one made from this value.

Required range: 0 <= x <= 64
instructions
string

The kit owner's style notes (see tokens.instructions). An empty string removes them.

Maximum string length: 500
expectedVersion
integer

Refuse the change with a 409 when the kit was saved again since this version was read.

Response

The saved kit

success
boolean
required

Always true on a success.

Example:

true

data
object
required
Example:
meta
object

Extra information about the answer: where a page sits in a list, the cursor of the next page, or warnings about a call that succeeded with a caveat.