Update Product Modifier | BigCommerce Developer Center

import requests
url = "https://api.bigcommerce.com/stores/store_hash/v3/catalog/products/product_id/modifiers/modifier_id"
payload = {
    "type": "date",
    "required": True
}
headers = {
    "X-Auth-Token": "<apiKey>",
    "Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.json())

{
  "data": {
    "type": "date",
    "required": true,
    "sort_order": 1,
    "config": {
      "default_value": "string",
      "checked_by_default": true,
      "checkbox_label": "string",
      "date_limited": true,
      "date_limit_mode": "range",
      "date_earliest_value": "2025-08-15T15:52:01+00:00",
      "date_latest_value": "2026-08-15T15:52:01+00:00",
      "file_types_mode": "specific",
      "file_types_supported": [
        "images, documents, other"
      ],
      "file_types_other": [
        "pdf"
      ],
      "file_max_size": 5,
      "text_characters_limited": true,
      "text_min_length": 1,
      "text_max_length": 55,
      "text_lines_limited": true,
      "text_max_lines": 4,
      "number_limited": true,
      "number_limit_mode": "lowest",
      "number_lowest_value": 100,
      "number_highest_value": 1.1,
      "number_integers_only": false,
      "product_list_adjusts_inventory": true,
      "product_list_adjusts_pricing": true,
      "product_list_shipping_calc": "weight"
    },
    "option_values": [
      {
        "label": "Green",
        "sort_order": 0,
        "is_default": false,
        "value_data": {},
        "adjusters": {
          "price": {
            "adjuster": "relative",
            "adjuster_value": 5
          },
          "weight": {
            "adjuster": "relative",
            "adjuster_value": 5
          },
          "image_url": "https://cdn8.bigcommerce.com/s-{{store_hash}}/products/184/images/445/naturalcanvascart2_1024x1024__92347__29648.1534344533.1280.1280.jpg?c=2",
          "purchasing_disabled": {
            "status": true,
            "message": "string"
          }
        },
        "id": 1
      }
    ],
    "id": 12,
    "product_id": 77,
    "name": "Add-a-$5-Donation1535039590-191",
    "display_name": "Donation"
  },
  "meta": {}
}

Updates a product modifier.

Date modifiers are required to be provided in ISO-8601 ATOM format. Excluding them in a request will throw a server error.

Updates a product modifier. Date modifiers are required to be provided in [ISO-8601 ATOM](https://www.php.net/manual/en/class.datetimeinterface.php#datetimeinterface.constants.atom) format. Excluding them in a request will throw a server error.

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_idstringRequired

modifier_idstringRequired

Request

Common Modifier properties.

typeenumRequired

BigCommerce API, which determines how it will display on the storefront. Acceptable values: date, checkbox, file, text, multi_line_text, numbers_only_text, radio_buttons, rectangles, dropdown, product_list, product_list_with_images, swatch. Required in a /POST.

BigCommerce API, which determines how it will display on the storefront. Acceptable values: `date`, `checkbox`, `file`, `text`, `multi_line_text`, `numbers_only_text`, `radio_buttons`, `rectangles`, `dropdown`, `product_list`, `product_list_with_images`, `swatch`. Required in a /POST.

requiredbooleanRequired

Whether or not this modifier is required at checkout. Required in a /POST.

sort_orderintegerOptional

The order the modifiers display on the product detail page.

configobjectOptional

The values for option config can vary based on the Modifier created. See Configs to learn more about the type-specific config fields.

option_valueslist of objectsOptional

Contains information about the values for modifier types with options. Certain fields are not used for specific modifier types. See Option Values for more details.

display_namestringOptional

The name of the option shown on the storefront.

Response

dataobject

Product modifier

metaobject

Response metadata.

Errors

409

Conflict Error

422

Unprocessable Entity Error