Webhooks
Catalog
Brands
Brand Images
Brand Metafields
Category Images
Products
Product Bulk Pricing Rules
Product Complex Rules
Product Custom Fields
Product Images
Product Metafields
Product Modifiers
Product Modifier Values
Product Modifier Images
Product Options
Product Option Values
Product Reviews
Product Variants
Product Variants Metafields
Product Videos
Summary
Variants
put

/catalog/categories/{category_id}/metafields/{metafield_id}

Updates a Category Metafield.

Required Fields

  • none

Read-Only Fields

  • id
  • These fields can only be modified by the app (API credentials) that created the metafield:
    • namespace
    • key
    • permission_set

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.

Authorization

apiKey - X-Auth-Client
apiKey - X-Auth-Token

Request Parameters

2 Path Parameters
2 Headers

Request Body

1 Example
Schema
object

Properties for updating metafields.

id
integer

Unique ID of the Metafield. Read-Only.

1 validation
permission_set
string

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
1 validation + required
namespace
string

Namespace for the metafield, for organizational purposes. This is set set by the developer. Required for POST.

4 validations + required
key
string

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

4 validations + required
value
string

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

4 validations + required
description
string

Description for the metafields.

3 validations
resource_type
string

The type of resource with which the metafield is associated.

3 validations
resource_id
integer

The ID for the resource with which the metafield is associated.

4 validations
date_created
string

Date and time of the metafield’s creation. Read-Only.

2 validations
date_modified
string

Date and time when the metafield was last updated. Read-Only.

2 validations

Responses

1 Example
Schema
object
data
object

Properties for updating metafields.

meta
object

Empty meta object; may be used later.

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
2 path params not set
category_id
metafield_id
$$.env
2 variables not set
store_hash
X-Auth-Client
X-Auth-Token