Update Metafield

PUT

https://api.bigcommerce.com/stores/:store_hash/v3/customers/:customerId/metafields/:metafieldId

PUT

/stores/:store_hash/v3/customers/:customerId/metafields/:metafieldId

curl -X PUT https://api.bigcommerce.com/stores/store_hash/v3/customers/1/metafields/1 \
     -H "X-Auth-Token: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "id": 42
}'

{
  "data": [
    {
      "permission_set": "app_only",
      "namespace": "Sales Department",
      "key": "Staff Name",
      "value": "Ronaldo",
      "description": "order",
      "resource_type": "cart",
      "resource_id": 424242,
      "id": 1,
      "date_created": "2022-06-16T18:39:00+00:00",
      "date_modified": "2022-06-16T18:39:00+00:00",
      "owner_client_id": "ramciw4fnoz87it3ynjfif2zrkil5p"
    }
  ],
  "errors": [],
  "meta": {
    "pagination": {
      "total": 36,
      "count": 36,
      "per_page": 50,
      "current_page": 1,
      "total_pages": 1,
      "links": {
        "previous": "string",
        "current": "?page=1&limit=50",
        "next": "string"
      }
    }
  }
}

Updates customer metafields. To update the customer metafields, use 'customerId' and 'metafield' in the query parameters.

Authentication

X-Auth-Tokenstring

OAuth scopes

UI Name	Permission	Parameter
Customers	modify	`store_v2_customers`
Customers	read-only	`store_v2_customers_read_only`
Stored Payment Instruments	modify	`store_stored_payment_instruments`
Stored Payment Instruments	read-only	`store_stored_payment_instruments_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.

Path parameters

metafieldIdintegerRequired

The ID of the metafield belonging to the customer. The metafieldId is a generated response when sending a POST query to the Create a Customer Metafields endpoint.

customerIdintegerRequired

The ID of the customer.

store_hashstringRequired

Permanent ID of the BigCommerce store.

Request

This endpoint expects an object.

idintegerRequired

The ID of metafield to update.

permission_setenumOptional

Determines the visibility and writeability of the field by other API consumers.

Value	Description
`app_only`	Private to the app that owns the field.
`read`	Visible to other API consumers.
`write`	Open for reading and writing by other API consumers.
`read_and_sf_access`	Visible to other API consumers, including on the storefront.
`write_and_sf_access`	Open for reading and writing by other API consumers, including on the storefront.

Allowed values:

namespacestringOptional1-64 characters

Namespace for the metafield, for organizational purposes.

keystringOptional1-64 characters

The name of the field, for example: location_id, color.

valuestringOptional1-65535 characters

The value of the field, for example: 1, blue.

descriptionstringOptional0-255 characters

Description for the metafields.

Response

Response payload for the BigCommerce API.

datalist of objectsOptional

errorslist of anyOptional

Empty for 200 responses.

metaobjectOptional

Data about the response, including pagination and collection totals.

Errors

400

Bad Request Error

404

Not Found Error