Brands

Create a new brand

Creates a brand from a name and settings, including primary and secondary colors. Brands supply the logo, colors, and styling that templates render with.

post/brands

Headers

Idempotency-Keystring

A unique key that makes this request idempotent. If Courier receives another request with the same Idempotency-Key, it returns the stored response from the first request without performing the operation again (including the original status code and any error). Use it to safely retry POST requests after network failures without risking duplicate sends. The key is scoped to this endpoint.

x-idempotency-expirationstring

How long the idempotency key remains valid, as a Unix epoch timestamp in seconds or an ISO 8601 date string. Only applies when Idempotency-Key is provided. If omitted, the key is retained for 25 hours; the maximum is 1 year.

Request body

idstring nullable

namestring required

Response

idstring required

namestring required

publishedinteger nullable

createdinteger required

updatedinteger required

versionstring nullable

Changes

Changed in 3 of the 55 revisions of this API.27335

Jul 29, 2026f76bed79a9132See the full diff
- ○
  added the new optional header request parameter Idempotency-Key
  new-optional-request-parameter
- ○
  added the new optional header request parameter x-idempotency-expiration
  new-optional-request-parameter
May 28, 20264a6bb54f79752See the full diff
- ▲
  the request property settings became not nullable
  request-property-became-not-nullable
- ▲
  the request property settings became required
  request-property-became-required
Oct 7, 20257143ea51f30725333See the full diff
- ▲
  added the new required request property settings/email/header/logo
  new-required-request-property
- ▲
  added the new required request property settings/inapp/colors
  new-required-request-property
- ▲
  added the new required request property settings/inapp/icons
  new-required-request-property
- ▲
  added the new required request property settings/inapp/widgetBackground
  new-required-request-property
- ▲
  the request property settings/colors/primary became not nullable
  request-property-became-not-nullable
- ▲
  the request property settings/colors/secondary became not nullable
  request-property-became-not-nullable
- ▲
  the settings/email/footer request property type/format changed from / to object/
  request-property-type-changed
- ▲
  the settings/email/header request property type/format changed from / to object/
  request-property-type-changed
- ▲
  the settings/inapp request property type/format changed from / to object/
  request-property-type-changed
- ▲
  the response property published became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property settings became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property settings/email/footer became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property settings/email/header became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property snippets/items became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property version became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property published became optional for the status 200
  response-property-became-optional
- ▲
  the response property settings became optional for the status 200
  response-property-became-optional
- ▲
  the response property settings/email/footer became optional for the status 200
  response-property-became-optional
- ▲
  the response property settings/email/header became optional for the status 200
  response-property-became-optional
- ▲
  the response property snippets/items became optional for the status 200
  response-property-became-optional
- ▲
  the response property version became optional for the status 200
  response-property-became-optional
- ▲
  the settings/email/footer response's property type/format changed from / to object/ for status 200
  response-property-type-changed
- ▲
  the settings/email/header response's property type/format changed from / to object/ for status 200
  response-property-type-changed
- ▲
  the settings/inapp response's property type/format changed from / to object/ for status 200
  response-property-type-changed
- ▲
  removed the required property snippets/items/items/format from the response with the 200 status
  response-required-property-removed
- ●
  removed the request property settings/colors/tertiary
  request-property-removed
- ●
  removed the request property snippets/items/items/format
  request-property-removed
- ●
  removed the optional property settings/colors/tertiary from the response with the 200 status
  response-optional-property-removed
- ○
  added the new optional request property settings/email/footer/content
  new-optional-request-property
- ○
  added the new optional request property settings/email/footer/inheritDefault
  new-optional-request-property
- ○
  added the new optional request property settings/email/head
  new-optional-request-property
- ○
  added the new optional request property settings/email/header/barColor
  new-optional-request-property
- ○
  added the new optional request property settings/email/header/inheritDefault
  new-optional-request-property
- ○
  added the new optional request property settings/email/templateOverride
  new-optional-request-property
- ○
  added the new optional request property settings/inapp/borderRadius
  new-optional-request-property
- ○
  added the new optional request property settings/inapp/disableMessageIcon
  new-optional-request-property
- ○
  added the new optional request property settings/inapp/fontFamily
  new-optional-request-property
- ○
  added the new optional request property settings/inapp/placement
  new-optional-request-property
- ○
  the request property settings became nullable
  request-property-became-nullable
- ○
  the request property settings/email/footer became nullable
  request-property-became-nullable
- ○
  the request property settings/email/header became nullable
  request-property-became-nullable
- ○
  the request property snippets/items became nullable
  request-property-became-nullable
- ○
  the request property settings became optional
  request-property-became-optional
- ○
  the request property settings/email/footer became optional
  request-property-became-optional
- ○
  the request property settings/email/header became optional
  request-property-became-optional
- ○
  the request property snippets/items became optional
  request-property-became-optional
- ○
  added the optional property settings/email/footer/content to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property settings/email/footer/inheritDefault to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property settings/email/head to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property settings/email/header/barColor to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property settings/email/header/inheritDefault to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property settings/email/templateOverride to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property settings/inapp/borderRadius to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property settings/inapp/disableMessageIcon to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property settings/inapp/fontFamily to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property settings/inapp/placement to the response with the 200 status
  response-optional-property-added
- ○
  the response property id became required for the status 200
  response-property-became-required
- ○
  added the required property settings/email/header/logo to the response with the 200 status
  response-required-property-added
- ○
  added the required property settings/inapp/colors to the response with the 200 status
  response-required-property-added
- ○
  added the required property settings/inapp/icons to the response with the 200 status
  response-required-property-added
- ○
  added the required property settings/inapp/widgetBackground to the response with the 200 status
  response-required-property-added
This revision also has 93 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history