v1

latestOpenAPI 3.1.02026-07-223261135.0 KB

brand-kits

Update Brand Kit

Update a brand kit.

patch/brand-kits/{brand_kit_id}

Path parameters

brand_kit_idstring required

Prefixed bk_ wire ID (Crockford base32 body) — the canonical, recommended form. For back-compat, a bare UUID string is also accepted in both path parameters and JSON request bodies (older integrations that stored raw UUIDs keep working). Both are permanent, supported inputs.

Example:bk_01HT9WK8N3M2J4A5Z6P7Q8R9TV

Headers

Moda-Version'2026-04-12' | '2026-05-01'

Example:2026-05-01

Calendar-dated API version pin. New integrations should pin 2026-05-01 to opt into the newest response shapes. For back-compat the server also accepts requests with no header and resolves them to the current default (today: 2026-04-12); that default advances on each sunset date. Any unsupported value returns 400 unsupported_version.

Request body

titlestring nullable

New display name for the brand kit.

colorsobject[] nullable

Array of {color, label} objects. Replaces all existing colors.

fontsobject[] nullable

Array of {family, label, weight} objects. Replaces all existing fonts.

company_namestring nullable

Company name.

company_descriptionstring nullable

Brief company description.

taglinestring nullable

Company tagline or slogan.

brand_valuesstring[] nullable

List of brand values (e.g. 'innovative', 'trustworthy').

brand_aestheticstring[] nullable

Deprecated list of aesthetic descriptors (e.g. 'minimal', 'bold'). The free-text aesthetic is derived during brand-kit population and is not settable via this API.

brand_tone_of_voicestring[] nullable

List of tone-of-voice descriptors (e.g. 'professional', 'friendly').

default_theme_canvas_idstring nullable

Prefixed cvs_ wire ID (Crockford base32 body) — the canonical, recommended form. For back-compat, a bare UUID string is also accepted in both path parameters and JSON request bodies (older integrations that stored raw UUIDs keep working). Both are permanent, supported inputs.

Example request

{
  "default_theme_canvas_id": "cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV"
}

Response

Successful Response

object required