Pricing Templates

PUT /catalog/products/{product_id}/metafields/{metafield_id}

Updates a Product Metafield.

Required Fields

none

Read-Only Fields

id
These fields can only be modified using the API account that created the metafield:
- namespace
- key
- permission_set
- value

Usage Notes

Attempting to modify the namespace, key, permission_set, or value field using an API account different from the one used to create those metafields will result in a 403 error message.

Servers

https://api.bigcommerce.com/stores/{store_hash}/v3

Path parameters

Name	Type	Required	Description
`metafield_id`	Integer	Yes	The ID of the `Metafield`.
`product_id`	Integer	Yes	The ID of the `Product` to which the resource belongs.

Request headers

Name Type Required Description

Name	Type	Required	Description
`Accept`	String	Yes	The MIME type of the response body. Default value: "application/json"
`Content-Type`	String	Yes	The MIME type of the request body. Default value: "application/json"

Accept

String

Yes

The MIME type of the response body.

Default value: "application/json"

Content-Type

String

Yes

The MIME type of the request body.

Default value: "application/json"

Request body fields

Name	Type	Required	Description
`namespace`	String	Yes	Namespace for the metafield, for organizational purposes. This is set by the developer. Required for POST.
`description`	String	No	Description for the metafields.
`key`	String	Yes	The name of the field, for example: `location_id`, `color`. Required for POST.
`value`	String	Yes	The value of the field, for example: `1`, `blue`. You must enter a JSON formatted string for ShipperHQ metafields. Required for POST.
`permission_set`	String	Yes	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\| Valid values: `"read"` `"write_and_sf_access"` `"write"` `"read_and_sf_access"` `"app_only"`

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.

All third party trademarks (including logos and icons) are the property of their respective owners, which do not sponsor, authorize, or endorse this website.

Pricing Templates Integrations Blog Contact Us Help

Terms of Service Privacy Policy