Webhooks
Models
Catalog
Catalog
Products
Product Metafields
Product Bulk Pricing Rules
Product Custom Fields
Product Images
Product Variant Options
Product Variant Option Values
Product Variants
Product Variants Metafields
Product Modifiers
Product Modifier Values
Product Modifier Images
Product Complex Rules
Product Reviews
Brands
Brand Metafields
Brand Images
Category
Category Metafields
Category Images
Variants
Models
put

/catalog/products/{product_id}/videos/{video_id}

Updates a *Product Video.

Required Fields

  • none

Read-Only Fields

  • id

Authorization

apiKey - X-Auth-Client
apiKey - X-Auth-Token

Request Parameters

2 Path Parameters
2 Headers

Request Body

1 Example
Schema
object

The model for a PUT to update a video on a product.

title
string

The title for the video. If left blank, this will be filled in according to data on a host site.

2 validations
description
string

The description for the video. If left blank, this will be filled in according to data on a host site.

sort_order
integer

The order in which the video will be displayed on the product page. Higher integers give the video a lower priority. When updating, if the video is given a lower priority, all videos with a sort_order the same as or greater than the video’s new sort_order value will have their sort_orders reordered.

2 validations
type
string

The video type (a short name of a host site).

1 validation
id
integer

The unique numeric ID of the product video; increments sequentially.

1 validation

Responses

1 Example
Schema
object

Response payload for the BigCommerce API.

data
object

A product video model.

meta
object

Empty meta object; may be used later.

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
3 path params not set
store_hash
product_id
video_id
$$.env
2 variables not set
X-Auth-Client
X-Auth-Token