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
> }'

1 {
2   "data": [
3     {
4       "permission_set": "app_only",
5       "namespace": "Sales Department",
6       "key": "Staff Name",
7       "value": "Ronaldo",
8       "description": "order",
9       "resource_type": "cart",
10       "resource_id": 424242,
11       "id": 1,
12       "date_created": "2022-06-16T18:39:00+00:00",
13       "date_modified": "2022-06-16T18:39:00+00:00",
14       "owner_client_id": "ramciw4fnoz87it3ynjfif2zrkil5p"
15     }
16   ],
17   "errors": [],
18   "meta": {
19     "pagination": {
20       "total": 36,
21       "count": 36,
22       "per_page": 50,
23       "current_page": 1,
24       "total_pages": 1,
25       "links": {
26         "previous": "string",
27         "current": "?page=1&limit=50",
28         "next": "string"
29       }
30     }
31   }
32 }

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

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
> }'

1 {
2   "data": [
3     {
4       "permission_set": "app_only",
5       "namespace": "Sales Department",
6       "key": "Staff Name",
7       "value": "Ronaldo",
8       "description": "order",
9       "resource_type": "cart",
10       "resource_id": 424242,
11       "id": 1,
12       "date_created": "2022-06-16T18:39:00+00:00",
13       "date_modified": "2022-06-16T18:39:00+00:00",
14       "owner_client_id": "ramciw4fnoz87it3ynjfif2zrkil5p"
15     }
16   ],
17   "errors": [],
18   "meta": {
19     "pagination": {
20       "total": 36,
21       "count": 36,
22       "per_page": 50,
23       "current_page": 1,
24       "total_pages": 1,
25       "links": {
26         "previous": "string",
27         "current": "?page=1&limit=50",
28         "next": "string"
29       }
30     }
31   }
32 }

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

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

idintegerRequired

The ID of metafield to update.

permission_setenumOptional

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 objects

errorslist of any

Empty for 200 responses.

metaobject

Data about the response, including pagination and collection totals.

Errors

400

Bad Request Error

404

Not Found Error