Skip to main content
PATCH
/
v1
/
brand
curl --request PATCH \
  --url https://brew.new/api/v1/brand \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "identity": {
    "tagline": "Complete user management for modern apps."
  }
}
'
{
  "brand": {
    "brandId": "kx7b3s7fapqz8mjm12ekz1kxdx87yceg",
    "domain": "vercel.com",
    "status": "completed",
    "ready": true
  },
  "identity": {
    "brandName": "Vercel",
    "tagline": "Complete user management for modern apps."
  }
}
{
"error": {
"code": "INVALID_REQUEST",
"type": "invalid_request",
"message": "Request validation failed.",
"suggestion": "Fix the field reported in `param` and retry.",
"docs": "https://docs.brew.new/api-reference/api/errors",
"param": "identity"
}
}
{
"error": {
"code": "INVALID_API_KEY",
"type": "authentication_error",
"message": "The provided API key is invalid.",
"suggestion": "Check the API key format and retry with a valid active key.",
"docs": "https://docs.brew.new/api-reference/api/authentication"
}
}
{
"error": {
"code": "INSUFFICIENT_PERMISSIONS",
"type": "authorization_error",
"message": "The caller does not have the required permission.",
"suggestion": "Use an API key or session with the required permission.",
"docs": "https://docs.brew.new/api-reference/api/authentication",
"param": "emails"
}
}
{
"error": {
"code": "RATE_LIMITED",
"type": "rate_limit",
"message": "Too many requests.",
"suggestion": "Wait for the retry window before sending another request.",
"docs": "https://docs.brew.new/api-reference/api/rate-limits",
"retryAfter": 42
}
}
{
"error": {
"code": "INTERNAL_ERROR",
"type": "internal_error",
"message": "An unexpected error occurred.",
"suggestion": "Retry the request. If it keeps failing, contact support.",
"docs": "https://docs.brew.new/api-reference/api/errors"
}
}

Authorizations

Authorization
string
header
default:Bearer brew_your_api_key
required

Send your Brew API key as Authorization: Bearer brew_xxx.

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).

brand
object
required
identity
object
emailDesign
string
imageStyle
string
logos
object[]