> This page is for Developer. > For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.bigcommerce.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.bigcommerce.com/_mcp/server. # Update Channel Metafield PUT https://api.bigcommerce.com/stores/{store_hash}/v3/channels/{channel_id}/metafields/{metafield_id} Content-Type: application/json Updates a single channel metafield. **Usage Notes** * Attempting to modify `namespace`, `key`, and `permission_set` fields using a client ID different from the one used to create those metafields will result in a `403` error message. Reference: https://docs.bigcommerce.com/developer/api-reference/rest/admin/management/channels/metafields/update-channel-metafield ## Authentication - `X-Auth-Token` header (required) — ### OAuth scopes | UI Name | Permission | Parameter | |:--------|:-----------|:----------| | Channel Listings | modify | `store_channel_listings` | | Channel Listings | read-only | `store_channel_listings_read_only` | | Channel Settings | modify | `store_channel_settings` | | Channel Settings | read-only | `store_channel_settings_read_only` | | Sites & Routes | modify | `store_sites` | | Sites & Routes | read-only | `store_sites_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 ### Path parameters - `channel_id` (long, required) — The ID of a channel. - `metafield_id` (string, required) — The ID of the metafield. - `store_hash` (string, required) — Permanent ID of the BigCommerce store. ### Headers - `Accept` (string, required, default: application/json) — The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. ### Body (application/json) This endpoint expects a metafield_Put. - `namespace` (string, optional) — Namespace for the metafield, for organizational purposes. - `key` (string, optional) — The name of the field. - `value` (string, optional) — The value of the field. - `permission_set` (enum, optional) — 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: `app_only`, `read`, `write`, `read_and_sf_access`, `write_and_sf_access` - `description` (string, optional) — Description for the metafield. ## Response ### 200 OK - `data` (Metafield, optional) — Common Metafield properties. - `meta` (EmptyMeta, optional) — Response metadata. ## Errors ### 400 Bad Request Error Bad Request. Input is invalid. - `status` (double, optional) - `title` (string, optional) - `type` (string, optional) - `detail` (string, optional) ### 404 Not Found Error Not found (A metafield was not found with this query). - `status` (integer, optional) — 404 HTTP status code. - `title` (string, optional) — The error title describing the particular error. - `type` (string, optional) - `instance` (string, optional) ## Types ### Metafield Common Metafield properties. - `permission_set` (enum, required) — 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: `app_only`, `read`, `write`, `read_and_sf_access`, `write_and_sf_access` - `namespace` (string, required) — Namespace for the metafield, for organizational purposes. - `key` (string, required) — The name of the field, for example: `location_id`, `color`. - `value` (string, required) — The value of the field, for example: `1`, `blue`. - `description` (string, required) — Description for the metafields. - `resource_type` (enum, required) — The type of resource with which the metafield is associated. - Allowed values: `brand`, `product`, `variant`, `category`, `cart`, `channel`, `location`, `order`, `customer` - `resource_id` (integer, required) — The unique identifier for the resource with which the metafield is associated. - `id` (integer, required) — The unique identifier for the metafield. - `date_created` (datetime, required) — Date and time of the metafieldʼs creation. - `date_modified` (datetime, required) — Date and time when the metafield was last updated. - `owner_client_id` (string, optional) — Client ID for the metafieldʼs creator. ### EmptyMeta Response metadata. ## Examples **Request** ```json {} ``` **Response** ```json { "data": { "permission_set": "write", "namespace": "Warehouse Locations", "key": "Location", "value": "4HG", "description": "Location in the warehouse", "resource_type": "channel", "resource_id": 1, "id": 17, "date_created": "2026-09-23T20:46:35+00:00", "date_modified": "2026-09-23T20:46:35+00:00", "owner_client_id": "bqvi1ms6c5765704fibi5zgyuddv26f" }, "meta": {} } ``` **SDK Code** ```python Response import requests url = "https://api.bigcommerce.com/stores/store_hash/v3/channels/1/metafields/metafield_id" payload = {} headers = { "Accept": "application/json", "X-Auth-Token": "", "Content-Type": "application/json" } response = requests.put(url, json=payload, headers=headers) print(response.json()) ``` ```javascript Response const url = 'https://api.bigcommerce.com/stores/store_hash/v3/channels/1/metafields/metafield_id'; const options = { method: 'PUT', headers: { Accept: 'application/json', 'X-Auth-Token': '', 'Content-Type': 'application/json' }, body: '{}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go Response package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.bigcommerce.com/stores/store_hash/v3/channels/1/metafields/metafield_id" payload := strings.NewReader("{}") req, _ := http.NewRequest("PUT", url, payload) req.Header.Add("Accept", "application/json") req.Header.Add("X-Auth-Token", "") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby Response require 'uri' require 'net/http' url = URI("https://api.bigcommerce.com/stores/store_hash/v3/channels/1/metafields/metafield_id") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Put.new(url) request["Accept"] = 'application/json' request["X-Auth-Token"] = '' request["Content-Type"] = 'application/json' request.body = "{}" response = http.request(request) puts response.read_body ``` ```java Response import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.put("https://api.bigcommerce.com/stores/store_hash/v3/channels/1/metafields/metafield_id") .header("Accept", "application/json") .header("X-Auth-Token", "") .header("Content-Type", "application/json") .body("{}") .asString(); ``` ```php Response request('PUT', 'https://api.bigcommerce.com/stores/store_hash/v3/channels/1/metafields/metafield_id', [ 'body' => '{}', 'headers' => [ 'Accept' => 'application/json', 'Content-Type' => 'application/json', 'X-Auth-Token' => '', ], ]); echo $response->getBody(); ``` ```csharp Response using RestSharp; var client = new RestClient("https://api.bigcommerce.com/stores/store_hash/v3/channels/1/metafields/metafield_id"); var request = new RestRequest(Method.PUT); request.AddHeader("Accept", "application/json"); request.AddHeader("X-Auth-Token", ""); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift Response import Foundation let headers = [ "Accept": "application/json", "X-Auth-Token": "", "Content-Type": "application/json" ] let parameters = [] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.bigcommerce.com/stores/store_hash/v3/channels/1/metafields/metafield_id")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "PUT" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```