Update Product Modifier Value

curl -X PUT https://api.bigcommerce.com/stores/store_hash/v3/catalog/products/1/modifiers/1/values/1 \
     -H "Accept: application/json" \
     -H "X-Auth-Token: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "label": "Green",
  "sort_order": 0
}'

{
  "data": {
    "adjusters": {
      "price": {
        "adjuster": "relative",
        "adjuster_value": 5
      },
      "weight": {},
      "image_url": "",
      "purchasing_disabled": {
        "status": false,
        "message": ""
      }
    },
    "id": 190,
    "is_default": false,
    "label": "Yes",
    "option_id": 222,
    "sort_order": 0,
    "value_data": {}
  },
  "meta": {}
}

Updates a modifier value.

Read-Only Fields

is_default

Setting an option value image adjusters.image_url is read-only on this endpoint. To replace the image shown on the storefront for the value, upload a new image via Create Product Modifier Image. The upload binds the image to the value automatically; no follow-up call is needed.

is_default is derived from the parent modifier configuration and cannot be set on individual values. To change which value is the default, use Update Product Modifier and include the full option_values array with the desired is_default flags.

Updates a modifier value. **Read-Only Fields** * is_default **Setting an option value image** `adjusters.image_url` is read-only on this endpoint. To replace the image shown on the storefront for the value, upload a new image via [Create Product Modifier Image](/developer/api-reference/rest/admin/catalog/product-modifiers/images/create-product-modifier-image). The upload binds the image to the value automatically; no follow-up call is needed. > `is_default` is derived from the parent modifier configuration and cannot be set on individual values. To change which value is the default, use [Update Product Modifier](/developer/api-reference/rest/admin/catalog/product-modifiers/update-product-modifier) and include the full `option_values` array with the desired `is_default` flags.

Authentication

X-Auth-Tokenstring

OAuth scopes

UI Name	Permission	Parameter
Products	modify	`store_v2_products`
Products	read-only	`store_v2_products_read_only`

Authentication header

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

### OAuth scopes | UI Name | Permission | Parameter | |:--------|:-----------|:----------| | Products | modify | `store_v2_products` | | Products | read-only | `store_v2_products_read_only` | ### Authentication header | Header | Argument | Description | |:-------|:---------|:------------| | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). | ### Further reading For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests). For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).

Path parameters

product_idintegerRequired

The ID of the product to which the resource belongs.

modifier_idintegerRequired

The ID of the product modifier.

value_idintegerRequired

The ID of the product modifier value.

store_hashstringRequired

Permanent ID of the BigCommerce store.

Request

The model for a PUT to update a modifier value on a product.

labelstringRequired

The text display identifying the value on the storefront. Required in a /POST.

sort_orderintegerRequired

The order in which the value will be displayed on the product page. Required in a /POST.

value_dataobjectOptional

Extra data describing the value, based on the type of option or modifier with which the value is associated. See Option Values for more details.

adjustersobjectOptional

idintegerOptional

The unique numeric ID of the value; increments sequentially.

Response

dataobject

Product modifier option_value.

metaobject

Response metadata.

Errors

422

Unprocessable Entity Error

Authentication

OAuth scopes

Authentication header

Further reading

Path parameters

Headers

Request

Response

Errors

OAuth scopes

Authentication header

Further reading