v1

latestOpenAPI 3.0.0Apache 2.02026-07-143281,4552.1 MB
Catalog

UpdateCatalogImage

Uploads a new image file to replace the existing one in the specified CatalogImage object.

This UpdateCatalogImage endpoint accepts HTTP multipart/form-data requests with a JSON part and an image file part in JPEG, PJPEG, PNG, or GIF format. The maximum file size is 15MB.

put/v2/catalog/images/{image_id}

Path parameters

image_idstring required

The ID of the CatalogImage object to update the encapsulated image file.

Response

Success

Example response

{
  "image": {
    "id": "L52QOQN2SW3M5QTF9JOCQKNB",
    "image_data": {
      "caption": "A picture of a cup of coffee",
      "name": "Coffee",
      "url": "https://..."
    },
    "type": "IMAGE"
  }
}