Closed Beta ProgramsShared Options and ModifiersAPI ReferenceModifiers

Update Shared Modifiers (batch)

Beta
Bulk update shared modifiers using modifier IDs.

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](/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).

Request

This endpoint expects a list of objects.
namestringRequired1-255 characters
The unique name identifying the shared modifier in the control panel. Name is unique within a store.
storefront_namestringRequired1-255 characters
The text display identifying the shared modifier on the storefront.
typeenumRequired
Type of shared modifier. Each type has a unique display style on the storefront. Different types may have different data for available values; see the `values` field. Some types include additional information for you to configure; see the `config` field. For an explanation of each type, see the [Overview](/beta/shared-options-modifiers).
configobject or list of anyOptional

Returns as an object for modifier types that have configuration.

Returns as an empty array for multiple choice modifiers; for a list of multiple choice types, see Shared Options and Modifiers Overview.

Schema depends on the modifier type. Click on the modifier type to view the schema.

idintegerOptional

The unique numeric ID of the value; increments sequentially.

requiredbooleanOptional
Whether or not this shared modifier is required or not at checkout.
valueslist of objectsOptional
Data describing modifier values, based on the type of modifier. Include only for types that have values, which are dropdown, radio buttons, rectangle list, swatch, and checkbox types.

Response

An array of SharedModifier objects.

datalist of objects
metaobject
Data about the response, including pagination and collection totals.

Errors

422
Unprocessable Entity Error