Skip to main content
PATCH
/
catalog
/
products
/
{product_pk}
/
image
/
{pk}
Update a product image
curl --request PATCH \
  --url https://api.kelviq.com/api/v1/catalog/products/{product_pk}/image/{pk}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "primary-hero.png",
  "ordering": 1,
  "thumbnail": true,
  "enabled": true
}
'
{
  "id": "1f7e1b54-7c6f-4d7e-9a4f-2c9c2d8b9d31",
  "name": "hero-banner.png",
  "image": "media/.../products/<id>/<uuid>/hero-banner.png",
  "ordering": 0,
  "thumbnail": true,
  "enabled": true
}

Authorizations

​
Authorization
string
header
required

The Server API Key obtained from the kelviq application. Pass as a Bearer token in the Authorization header. Example: 'Authorization: Bearer YOUR_API_KEY'

Path Parameters

​
product_pk
string<uuid>
required

Parent product UUID.

​
pk
string<uuid>
required

Image UUID.

Body

application/json

Editable fields on a product image. The underlying file cannot be changed; upload a new image instead.

​
name
string

Display name.

Example:

"primary-hero.png"

​
ordering
integer

Position in the gallery.

Example:

1

​
thumbnail
boolean

If true, marks this image as the product thumbnail and unsets the flag on other images.

Example:

true

​
enabled
boolean
Example:

true

Response

Updated product image.

An image asset attached to a product.

​
id
string<uuid>
read-only

Unique identifier for the image.

Example:

"1f7e1b54-7c6f-4d7e-9a4f-2c9c2d8b9d31"

​
name
string | null

Original filename or display name.

Example:

"hero-banner.png"

​
image
string
read-only

Storage key / URL for the image asset.

Example:

"media/.../products/<id>/<uuid>/hero-banner.png"

​
ordering
integer

Position of the image in the gallery.

Example:

0

​
thumbnail
boolean

If true, this image is used as the product thumbnail.

Example:

true

​
enabled
boolean

If true, the image is shown publicly.

Example:

true