---
title: "Update an item brand"
method: PUT
path: "/v1/item_brands/{item_brand_id}"
tags: ["Item Brands"]
---

# Update an item brand

`PUT /v1/item_brands/{item_brand_id}`

## Request

- Base URL: `https://api.yoco.com`
- URL: `https://api.yoco.com/v1/item_brands/{item_brand_id}`
- Auth: HTTP bearer

Replace an item brand. The request carries every field, and `null` clears a value.

**Required scopes: `business/catalogue:read`, `business/catalogue:write`**

## Path parameters

- `item_brand_id` string, required: The unique identifier of the item brand.

## Request body

- UpdateItemBrandRequest: `UpdateItemBrandRequest` carries the complete brand, as an update replaces the whole object. Every field is required, and `null` clears a value.
  - `name` string, required: The name of the brand. Leading and trailing whitespace is removed, and the name that remains must be 1 to 255 characters long, and unique among the business's brands.
  - `description` string, nullable, required: A description of the brand. Leading and trailing whitespace is removed, and the description that remains must be 1 to 255 characters long. Send `null` to clear it.
  - `image_id` string, nullable, required: The `id` of the brand's image, a media item uploaded with `POST /v1/media/`. Send `null` to clear it.

## Response `200`

Successful Response

- ItemBrand
  - `id` string, required: The unique identifier of the brand.
  - `name` string, required: The name of the brand.
  - `description` string, nullable, required: A description of the brand.
  - `image` Media, required
    - `id` string, required: The unique identifier of the media.
    - `type` 'image', required
    - `mime_type` string, required: The mime type indicates the format of the media.
    - `url` string, required: The URL of the media file.
    - `created_at` string, date-time, required: The media creation date and time in ISO 8601 format.
    - `updated_at` string, date-time, nullable, required: The date and time the media was last modified in ISO 8601 format.
  - `created_at` string, date-time, required: The brand creation date and time in ISO 8601 format.
  - `updated_at` string, date-time, nullable, required: The date and time the brand was last modified in ISO 8601 format.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `409`: Conflict
- `429`: Too Many Requests

## Changes

- **2026-10-15** `2505c2f21875`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/yoco/apis/yoco-api/changes/v1/item_brands/:item_brand_id/put.md)

---

[API](https://skmtc.dev/yoco/apis/yoco-api.md) - [All operations](https://skmtc.dev/yoco/apis/yoco-api/llms.txt) - [OpenAPI document](https://skmtc.dev/yoco/apis/yoco-api/revisions/daf9b9d86161?raw)
