Update Media

Update the media for a product.

put

/v1/catalog/products/{productId}/media/{id}

Path parameters

productIdstringrequired

idstringrequired

Body

application/jsontext/jsonapplication/*+json

idstring

auditobject

$metaobject

hrefstring

namestring

typestring

descriptionstring

statusstring

filenamestring

sizeinteger · int32

contentTypestring

displayOrderinteger · int32

urlstring

productobject

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/v1/catalog/products/{productId}/media/{id}' \
  --header 'Content-Type: application/json' \
  --data '{"audit":{"created":{"by":{"audit":{"created":{"by":"[Circular Reference]"},"updated":{"by":"[Circular Reference]"}},"$meta":{"omitted":[null]}}},"updated":{"by":"[Circular Reference]"}},"$meta":{"omitted":[null]},"product":{"audit":{"created":{"by":{"audit":{"created":{"by":"[Circular Reference]"},"updated":{"by":"[Circular Reference]"}},"$meta":{"omitted":[null]}}},"updated":{"by":{"audit":{"created":{"by":"[Circular Reference]"},"updated":{"by":"[Circular Reference]"}},"$meta":{"omitted":[null]}}},"published":{"by":{"audit":{"created":{"by":"[Circular Reference]"},"updated":{"by":"[Circular Reference]"}},"$meta":{"omitted":[null]}}},"pending":{"by":{"audit":{"created":{"by":"[Circular Reference]"},"updated":{"by":"[Circular Reference]"}},"$meta":{"omitted":[null]}}},"unpublished":{"by":{"audit":{"created":{"by":"[Circular Reference]"},"updated":{"by":"[Circular Reference]"}},"$meta":{"omitted":[null]}}}},"$meta":{"omitted":[null]},"externalIds":{},"vendor":{"audit":{"created":{"by":{"audit":{"created":{"by":"[Circular Reference]"},"updated":{"by":"[Circular Reference]"}},"$meta":{"omitted":[null]}}},"updated":{"by":"[Circular Reference]"}},"$meta":{"omitted":[null]},"externalIds":{},"type":"Client","status":"Active","serviceLevel":"Express","address":{"addressLine1":"text","postCode":"text","city":"text","state":"text","country":"text"},"name":"text","groups":[{"audit":{"created":{"by":{"audit":{"created":{"by":"[Circular Reference]"},"updated":{"by":"[Circular Reference]"}},"$meta":{"omitted":[null]}}},"updated":{"by":"[Circular Reference]"}},"$meta":{"omitted":[null]},"account":{"audit":{"created":{"by":{"audit":{"created":{"by":"[Circular Reference]"},"updated":{"by":"[Circular Reference]"}},"$meta":{"omitted":[null]}}},"updated":{"by":"[Circular Reference]"}},"$meta":{"omitted":[null]},"externalIds":{},"type":"Client","status":"Active","serviceLevel":"Express","address":{"addressLine1":"text","postCode":"text","city":"text","state":"text","country":"text"},"name":"text","groups":"[Circular Reference]"},"modules":["[Circular Reference]"],"users":["[Circular Reference]"],"buyers":["[Circular Reference]"]}]},"settings":{"productRequests":{},"preValidation":{},"splitBilling":{}},"statistics":{}}}'

200

404

200

{
  "id": "text",
  "audit": {
    "created": {
      "by": {
        "audit": {
          "created": {
            "by": "[Circular Reference]"
          },
          "updated": {
            "by": "[Circular Reference]"
          }
        },
        "$meta": {
          "omitted": [
            null
          ]
        }
      }
    },
    "updated": {
      "by": "[Circular Reference]"
    }
  },
  "$meta": {
    "omitted": [
      null
    ]
  },
  "href": "text",
  "name": "text",
  "type": "text",
  "description": "text",
  "status": "text",
  "filename": "text",
  "size": 1,
  "contentType": "text",
  "displayOrder": 1,
  "url": "text",
  "product": {
    "audit": {
      "created": {
        "by": {
          "audit": {
            "created": {
              "by": "[Circular Reference]"
            },
            "updated": {
              "by": "[Circular Reference]"
            }
          },
          "$meta": {
            "omitted": [
              null
            ]
          }
        }
      },
      "updated": {
        "by": {
          "audit": {
            "created": {
              "by": "[Circular Reference]"
            },
            "updated": {
              "by": "[Circular Reference]"
            }
          },
          "$meta": {
            "omitted": [
              null
            ]
          }
        }
      },
      "published": {
        "by": {
          "audit": {
            "created": {
              "by": "[Circular Reference]"
            },
            "updated": {
              "by": "[Circular Reference]"
            }
          },
          "$meta": {
            "omitted": [
              null
            ]
          }
        }
      },
      "pending": {
        "by": {
          "audit": {
            "created": {
              "by": "[Circular Reference]"
            },
            "updated": {
              "by": "[Circular Reference]"
            }
          },
          "$meta": {
            "omitted": [
              null
            ]
          }
        }
      },
      "unpublished": {
        "by": {
          "audit": {
            "created": {
              "by": "[Circular Reference]"
            },
            "updated": {
              "by": "[Circular Reference]"
            }
          },
          "$meta": {
            "omitted": [
              null
            ]
          }
        }
      }
    },
    "$meta": {
      "omitted": [
        null
      ]
    },
    "externalIds": {},
    "vendor": {
      "audit": {
        "created": {
          "by": {
            "audit": {
              "created": {
                "by": "[Circular Reference]"
              },
              "updated": {
                "by": "[Circular Reference]"
              }
            },
            "$meta": {
              "omitted": [
                null
              ]
            }
          }
        },
        "updated": {
          "by": "[Circular Reference]"
        }
      },
      "$meta": {
        "omitted": [
          null
        ]
      },
      "externalIds": {},
      "type": "Client",
      "status": "Active",
      "serviceLevel": "Express",
      "address": {
        "addressLine1": "text",
        "postCode": "text",
        "city": "text",
        "state": "text",
        "country": "text"
      },
      "name": "text",
      "groups": [
        {
          "audit": {
            "created": {
              "by": {
                "audit": {
                  "created": {
                    "by": "[Circular Reference]"
                  },
                  "updated": {
                    "by": "[Circular Reference]"
                  }
                },
                "$meta": {
                  "omitted": [
                    null
                  ]
                }
              }
            },
            "updated": {
              "by": "[Circular Reference]"
            }
          },
          "$meta": {
            "omitted": [
              null
            ]
          },
          "account": {
            "audit": {
              "created": {
                "by": {
                  "audit": {
                    "created": {
                      "by": "[Circular Reference]"
                    },
                    "updated": {
                      "by": "[Circular Reference]"
                    }
                  },
                  "$meta": {
                    "omitted": [
                      null
                    ]
                  }
                }
              },
              "updated": {
                "by": "[Circular Reference]"
              }
            },
            "$meta": {
              "omitted": [
                null
              ]
            },
            "externalIds": {},
            "type": "Client",
            "status": "Active",
            "serviceLevel": "Express",
            "address": {
              "addressLine1": "text",
              "postCode": "text",
              "city": "text",
              "state": "text",
              "country": "text"
            },
            "name": "text",
            "groups": "[Circular Reference]"
          },
          "modules": [
            "[Circular Reference]"
          ],
          "users": [
            "[Circular Reference]"
          ],
          "buyers": [
            "[Circular Reference]"
          ]
        }
      ]
    },
    "settings": {
      "productRequests": {},
      "preValidation": {},
      "splitBilling": {}
    },
    "statistics": {}
  }
}

OK