Skip to navigation
RESTAdminManagementCustomersV3Attribute Values

Upsert Customer Attribute Values

Upserts Customer Attribute Values. Updates the attribute values on the Customer. Multiple customer attribute values can be updated in one call.

Upsert checks for an existing record. If there is none, it creates the record, if there is a matching record, it updates that record.

Limits

  • Limit of 10 customers per call.
  • Limit of 3 concurrent requests.

Authentication

X-Auth-Tokenstring

OAuth scopes

UI NamePermissionParameter
Customersmodifystore_v2_customers
Customersread-onlystore_v2_customers_read_only
Stored Payment Instrumentsmodifystore_stored_payment_instruments
Stored Payment Instrumentsread-onlystore_stored_payment_instruments_read_only

Authentication header

HeaderArgumentDescription
X-Auth-Tokenaccess_tokenFor more about API accounts that generate access_tokens, see our Guide to API Accounts.

Further reading

For example requests and more information about authenticating BigCommerce APIs, see Authentication and Example Requests.

For more about BigCommerce OAuth scopes, see our Guide to API Accounts.

For a list of API status codes, see API Status Codes.

Path parameters

store_hashstringRequired
Permanent ID of the BigCommerce store.

Headers

AcceptstringOptionalDefaults to application/json

The MIME type of the response body that the client accepts. Typically application/json.

Request

This endpoint expects a list of objects.
attribute_idintegerRequired
Attribute ID.
valuestringRequired0-255 characters

Attribute value. This will always be a string, regardless of the attributeʼs type.

Corresponds to attribute_value used in customer attribute values GET requests.

customer_idintegerRequired
Customer ID.
idintegerOptional
Attribute value ID.

Response

A list of customer attribute values.
datalist of objectsOptional
metaobjectOptional
Data about the response, including pagination and collection totals.

Errors

422
Unprocessable Entity Error