Update Branding Theme

Sparse-update a branding theme. Only the keys you send are changed. Unknown keys return 422. Setting is_default: true clears the previous default. Setting is_default: false is allowed and may leave the store with no default — see Default.

Request

PATCH /branding-themes/{id}

Path Parameters

Parameter	Type	Required	Description
id	string	Yes	Branding theme UUID.

Request Body

All fields optional. Omit a key to leave it unchanged. Send null on a nullable field to clear it.

Parameter	Type	Required	Description
name	string	No	Label, 1–255 characters.
is_default	boolean	No	See Default.
font	string	No	Font name, max 255.
logo_url	string	No	HTTP logo URL, max 2048.
logo_square_url	string	No	HTTP square logo URL, max 2048.
brand_color	string	No	Hex colour. See Colours.
background_color	string	No	Hex colour.
text_color	string	No	Hex colour.
card_background_color	string	No	Hex colour.
card_text_color	string	No	Hex colour.
border_color	string	No	Hex colour.

Example Request

curl -X PATCH "https://cart.easy.tools/api/v1/branding-themes/f670a72a-7a46-4853-9ebb-91ddf691358e" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Studio patched",
    "is_default": true
  }'

Response

Success Response (200)

Returns the Branding Theme Object.

{
  "id": "f670a72a-7a46-4853-9ebb-91ddf691358e",
  "name": "Studio patched",
  "is_default": true,
  "font": null,
  "logo_url": "https://cdn.example.com/branding/studio-logo.png",
  "logo_square_url": null,
  "brand_color": "#101828",
  "background_color": "#f9fafb",
  "text_color": "#101828",
  "card_background_color": "#ffffff",
  "card_text_color": "#101828",
  "border_color": "#d0d5dd"
}

Error Responses

Bad Request (400)

{
  "message": "Invalid branding theme ID"
}

Not Found Error (404)

{
  "message": "Branding theme with ID f670a72a-7a46-4853-9ebb-91ddf691358e not found"
}

Validation Error (422 Unprocessable Entity)

{
  "message": "The given data was invalid.",
  "errors": {
    "id": [
      "The id field is not allowed."
    ]
  }
}

Colour format errors use the same envelope as Create Branding Theme.

Unauthorized Error (401)

{
  "message": "Unauthenticated."
}

Forbidden Error (403)

{
  "message": "You do not have API access to the requested store."
}