Update a brand kit

Update a brand kit

PATCH/api/v1/brand-kits/{id}

PATCH /brand-kits/{id}
curl -X PATCH 'https://www.unitpost.com/api/v1/brand-kits/bk_123' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0' \
  -H 'Content-Type: application/json' \
  -d '{ }'
Response · 200
{
  "object": "brand_kit",
  "id": "id_123",
  "name": "Example",
  "is_default": false,
  "website_url": "https://example.com",
  "description": "string",
  "tone": "NEUTRAL",
  "voice_notes": "string",
  "industry": "string",
  "core_pages": [
    {
      "url": "https://example.com",
      "title": "string"
    }
  ],
  "extracted": {
    "colors": [
      {
        "hex": "string",
        "label": "string"
      }
    ],
    "logo_urls": [
      "string"
    ],
    "background_urls": [
      "string"
    ],
    "fonts": [
      "string"
    ]
  },
  "graphics": [
    {
      "library_image_id": "library_image_123",
      "image_id": "image_123",
      "path": "string",
      "role": "logo",
      "label": "string"
    }
  ],
  "source": "string",
  "updated_at": "2026-01-01T00:00:00.000Z"
}

Edit a profile: voice, tone, description, industry, website, core pages, the palette and logo candidates (extracted), and the pinned graphics (library images, img_…). Only the fields sent change; a list replaces the list; null or "" clears a text field. sync_visual on the default profile also sets the email branding's accent from these colors. Requires the branding:write capability.

Parameters1 field
FieldTypeDescription
idrequiredstring · path—
Request body10 fields
FieldTypeDescription
namestring—
website_urlstring | nullAn https URL; `null` or `""` clears it.
descriptionstring | nullWhat the brand does.
toneenum | null—
voice_notesstring | nullDos and don'ts for writing in this voice.
industrystring | nullThe brand's industry.
core_pagesobject[]Replaces the list.
extractedobjectThe palette, logo and background candidates, fonts. Replaces the set.
graphicsobject[]The pinned library images (`img_…`). Replaces the list.
sync_visualbooleanOn the default profile, also set the email branding's accent from these colors (no change on another profile, or without a usable accent).
Response · 200 fields14 fields
FieldTypeDescription
objectrequiredstring—
idrequiredstring—
namerequiredstring—
is_defaultrequiredboolean—
website_urlrequiredstring | null—
descriptionrequiredstring | null—
tonerequiredenum | null—
voice_notesrequiredstring | null—
industryrequiredstring | null—
core_pagesrequiredobject[]—
extractedrequiredobject—
graphicsrequiredobject[]—
sourcerequiredstring | null—
updated_atrequiredstring | null—
200400401403404409422429

Search docs and guides

Search the docs and product guides.