Skip to main content
PATCH

Authorizations

Authorization
string
header
default:Bearer brew_your_api_key
required

Send your Brew API key as Authorization: Bearer brew_xxx.

Headers

X-Brand-Id
string

The brand this request acts on. REQUIRED for organization-scoped credentials (otherwise 400 BRAND_ID_REQUIRED — there is no default brand); list ids with GET /v1/brands. Brand-scoped credentials may omit it, and sending a different brand returns 403 BRAND_SCOPE_MISMATCH. A brand outside your organization returns 404 BRAND_NOT_FOUND.

Required string length: 1 - 64

Body

application/json
identity
object
emailDesign
string
Maximum string length: 200000
imageStyle
string
Maximum string length: 200000

Response

The updated brand (only the touched fields are echoed).

brandId
string
required
Minimum string length: 1
domain
string
required
Minimum string length: 1
status
enum<string>
required
Available options:
extracting,
completed,
failed,
deleting
ready
boolean
required
progress
integer
Required range: 0 <= x <= 100
phase
string
error
string
createdAt
string<date-time>
updatedAt
string<date-time>
identity
object
emailDesign
string
imageStyle
string
logos
object[]