---
title: "Replace a brand"
method: PUT
path: "/brands/{brand_id}"
tags: ["Brands"]
---

# Replace a brand

`PUT /brands/{brand_id}`

Replaces a brand with the values you supply, so send the complete settings and snippets rather than only the fields you want changed.

## Path parameters

- `brand_id` string, required

## Request body

- object
  - `name` string, required — The name of the brand.
  - `settings` BrandSettings
    - `colors` BrandColors
      - `primary` string
      - `secondary` string
    - `email` BrandSettingsEmail
      - `templateOverride` BrandTemplateOverride
        - `backgroundColor` string, nullable
        - `blocksBackgroundColor` string, nullable
        - `enabled` boolean, required
        - `footer` string, nullable
        - `head` string, nullable
        - `header` string, nullable
        - `width` string, nullable
      - `head` EmailHead
        - `inheritDefault` boolean, required
        - `content` string, nullable
      - `footer` EmailFooter
        - `content` string, nullable
        - `inheritDefault` boolean, nullable
      - `header` EmailHeader
        - `inheritDefault` boolean, nullable
        - `barColor` string, nullable
        - `logo` Logo, required
          - `href` string, nullable
          - `image` string, nullable
    - `inapp` BrandSettingsInApp
      - `borderRadius` string, nullable
      - `disableMessageIcon` boolean, nullable
      - `fontFamily` string, nullable
      - `placement` 'top' | 'bottom' | 'left' | 'right'
      - `widgetBackground` WidgetBackground, required
        - `topColor` string, nullable
        - `bottomColor` string, nullable
      - `colors` BrandColors, required
        - `primary` string
        - `secondary` string
      - `icons` Icons, required
        - `bell` string, nullable
        - `message` string, nullable
  - `snippets` BrandSnippets
    - `items` BrandSnippet[], nullable
      - `name` string, required
      - `value` string, required

## Response `200`

- Brand
  - `id` string, required
  - `name` string, required
  - `published` integer, nullable
  - `created` integer, required
  - `updated` integer, required
  - `settings` BrandSettings
    - `colors` BrandColors
      - `primary` string
      - `secondary` string
    - `email` BrandSettingsEmail
      - `templateOverride` BrandTemplateOverride
        - `backgroundColor` string, nullable
        - `blocksBackgroundColor` string, nullable
        - `enabled` boolean, required
        - `footer` string, nullable
        - `head` string, nullable
        - `header` string, nullable
        - `width` string, nullable
      - `head` EmailHead
        - `inheritDefault` boolean, required
        - `content` string, nullable
      - `footer` EmailFooter
        - `content` string, nullable
        - `inheritDefault` boolean, nullable
      - `header` EmailHeader
        - `inheritDefault` boolean, nullable
        - `barColor` string, nullable
        - `logo` Logo, required
          - `href` string, nullable
          - `image` string, nullable
    - `inapp` BrandSettingsInApp
      - `borderRadius` string, nullable
      - `disableMessageIcon` boolean, nullable
      - `fontFamily` string, nullable
      - `placement` 'top' | 'bottom' | 'left' | 'right'
      - `widgetBackground` WidgetBackground, required
        - `topColor` string, nullable
        - `bottomColor` string, nullable
      - `colors` BrandColors, required
        - `primary` string
        - `secondary` string
      - `icons` Icons, required
        - `bell` string, nullable
        - `message` string, nullable
  - `snippets` BrandSnippets
    - `items` BrandSnippet[], nullable
      - `name` string, required
      - `value` string, required
  - `version` string, nullable

---

[API](https://skmtc.net/trycourier/apis/courier.md) · [All operations](https://skmtc.net/trycourier/apis/courier/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/trycourier/courier/versions/04f69fbf96a5/schema)