Update collection metafield

TheUpdate collection metafieldaction adds ametafieldto the collection that triggers the workflow, or updates an existing metafield on that collection.

On this page

Fields

TheUpdate collection metafieldaction contains the following fields.

Fields used in the Update collection metafield action.
Field Description
Metafield namespace Required. A metafield namespace is a container for a group of metafields. Grouping metafields within a namespace prevents your metafields from conflicting with other metafields.
Key Required. A key is an identifier for the metafield value.
Value Required. The value is the information to be stored in the metafield. The value is always stored as a string, regardless of the metafield's type.
Type Thedata typeof the metafield's value.

Triggers

TheUpdate collection metafieldaction has a hidden field added to it by the trigger. This field,Collection ID, identifies the collection to add a metafield to. The collection ID is set by default and can't be changed.

TheUpdate collection metafieldaction can be used in workflows that start with the following triggers:

Example

Example of a workflow that adds a collection metafield when a collection is created

In this example workflow, a collection metafield is added to all newly created collections.

API details

To learn more, review theMetafieldInputinput object.

Ready to start selling with Shopify?

Try it free