Update Metafield
Updates a Metafield object.
The maximum number of metafields allowed on each order, product, category, variant, or brand is 250 per client ID.
Authentication
X-Auth-Tokenstring
### OAuth scopes
| UI Name | Permission | Parameter |
|:--------|:-----------|:----------|
| Order Transactions | read and modify `transactions` and `payment_methods` | `store_v2_transactions` |
| Order Transactions | read `transactions` and `payment_methods` | `store_v2_transactions_read_only` |
| Orders | read and modify `payment_methods` |`store_v2_orders`|
| Orders | read `payment_methods` |`store_v2_orders_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-accounts#api-accounts). |
### Further reading
For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-accounts#x-auth-token-header-example-requests).
For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/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
order_id
metafield_id
Request
A Metafield object.
key
The name of the field, for example: location_id, color.
namespace
Namespace for the metafield, for organizational purposes.
permission_set
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 storefront|
|`write_and_sf_access`|Open for reading and writing by other API consumers, including on storefront|
Allowed values:
value
The value of the field, for example: 1, blue.
description
Description for the metafields.
Response
A metafield and metadata.
data
Allows app partners to write custom data to various resources in the API.
meta
Response metadata.
Errors
400
Bad Request Error
404
Not Found Error
