mutation">productUpdateMedia mutation
- Required access
On this page
Interactive example
Arguments
UpdateMediaInput fields
Return fields
Deprecated return fields

productUpdateMedia mutation

Updates media for a product.

Required access

write_products access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.

mutation productUpdateMedia($productId: ID!, $media: [UpdateMediaInput!]!) { productUpdateMedia(productId: $productId, media: $media) {

<font style="color:#1F61A0;">media</font> <font style="color:#555555;">{</font>
  <font style="color:#1F61A0;">alt</font>
<font style="color:#555555;">}</font>
<font style="color:#1F61A0;">mediaUserErrors</font> <font style="color:#555555;">{</font>
  <font style="color:#1F61A0;">code</font>
  <font style="color:#1F61A0;">field</font>
  <font style="color:#1F61A0;">message</font>
<font style="color:#555555;">}</font>
<font style="color:#1F61A0;">product</font> <font style="color:#555555;">{</font>
  <font style="color:#1F61A0;">id</font>
<font style="color:#555555;">}</font>

} } { “productId”: “Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=”, “media”: [

<font style="color:#555555;">{</font>
  <font style="color:#8B2BB9;">"id"</font><font style="color:#555555;">:</font> <font style="color:#D64292;">"Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="</font>
<font style="color:#555555;">}</font>

] }

Arguments

Argument	Description
`media` ( `[[UpdateMediaInput!]!](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/updatemediainput)` ) REQUIRED	A list of media updates.
`productId` ( `[ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)` ) REQUIRED	Specifies the product to update media on.

UpdateMediaInput fields

alt ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
The alt text associated to the media.
id ([ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)) REQUIRED
Specifies the media to update.
previewImageSource ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
The source from which to update the media preview image. May be an external URL or signed upload URL.

Return fields

media ([[Media!]](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/media))
The updated media.
mediaUserErrors ([[MediaUserError!]!](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/mediausererror))
List of errors that occurred executing the mutation.
product ([Product](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/product))
The product which media was updated on.

Deprecated return fields

userErrors ([[UserError!]!](https://shopify.dev/docs/admin-api/graphql/reference/usererror)) DEPRECATED
List of errors that occurred executing the mutation.
Deprecation warning
Use mediaUserErrors instead

productUpdateMedia