Skip to main content
PATCH
/
v1
/
product_medias
/
{id}
Update
curl --request PATCH \
  --url https://{defaultHost}/v1/product_medias/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "product_media": {
    "position": 1
  }
}
'
{
  "id": "74b6bedd-1585-4783-9bba-95d1cb2ac891",
  "object": "product_media",
  "alt": null,
  "position": 1,
  "title": null,
  "url": null,
  "media": "3aef3e6b-4bfc-41e6-94f4-4a59016dd59a",
  "product": "aebfb31b-8309-4e2c-a1dd-d92ca25c2f36",
  "created_at": 1772113000,
  "updated_at": 1772113000
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Body

application/json
product_media
object

Response

200 - application/json

Success

id
string | null

The UUID of the specific object.

object
string

A string describing the object type returned.

alt
string | null

The HTML alt attribute for the product media.

position
integer | null

The ordering position of this product media when displayed to customers.

title
string | null

The HTML title attribute for the product media.

url
string | null

Instead of attaching a Media record, a public URL can be set. If set, this URL will be used to serve the product media asset.

media

Expandable – The associated media ID.

product

Expandable – The associated product ID.

created_at
integer | null

Time at which the object was created. Measured in seconds since the Unix epoch.

updated_at
integer | null

Time at which the object was last updated. Measured in seconds since the Unix epoch.