YOyoco
Item Brands

Update an item brand

Changed on

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

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

put/v1/item_brands/{item_brand_id}

Request

  • Base URL
    https://api.yoco.com
  • Auth
    HTTP bearer

Path parameters

item_brand_idstring required

The unique identifier of the item brand.

Request body

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

descriptionstring 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_idstring nullable required

The id of the brand's image, a media item uploaded with POST /v1/media/. Send null to clear it.

Example request

{
  "description": "Everyday products, built to last.",
  "image_id": "1757533814961-58f649da-81e3-4877-8769-f407cfba8aff",
  "name": "Acme"
}

Response

Successful Response

idstring required

The unique identifier of the brand.

namestring required

The name of the brand.

descriptionstring nullable required

A description of the brand.

created_atstring date-time required

The brand creation date and time in ISO 8601 format.

updated_atstring date-time nullable required

The date and time the brand was last modified in ISO 8601 format.

Example response

{
  "created_at": "2024-11-19T15:27:02+00:00",
  "description": "Everyday products, built to last.",
  "id": "1757511249592-ab46acf9-7c86-4ee0-92b9-6b43e1429337",
  "image": {
    "created_at": "2024-11-19T15:27:02+00:00",
    "id": "1757533814961-58f649da-81e3-4877-8769-f407cfba8aff",
    "mime_type": "image/jpeg",
    "type": "image",
    "updated_at": "2024-11-19T16:27:23+00:00",
    "url": "https://images.yoco.com/foo/bar.jpg"
  },
  "name": "Acme",
  "updated_at": "2024-11-19T16:27:23+00:00"
}

Changes