PUT /catalog/brands/{brand_id}/metafields/{metafield_id}

Updates a brand metafield.

Required Fields

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.
The maximum number of metafields allowed on each order, product, category, variant, or brand is 250 per client ID. For more information, see Platform Limits in the Help Center.

Servers

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

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"

Name	Type	Required	Description
`namespace`	String	No	Namespace for the metafield, for organizational purposes.
`description`	String	No	Description for the metafields.
`key`	String	No	The name of the field, for example: `location_id`, `color`.
`permission_set`	String	No	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. \| Valid values: `"read"` `"write_and_sf_access"` `"write"` `"read_and_sf_access"` `"app_only"`
`value`	String	No	The value of the field, for example: `1`, `blue`.

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.