Add collection metafield

The Add collection metafield action adds a metafield to the collection that triggers the workflow, or updates an existing metafield on that collection.

Fields

The Add collection metafield action contains the following fields.

Fields used in the Add 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 others.
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 The data type of the metafield's value.

Triggers

The Add collection metafield action 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.

The Add collection metafield action can be used in workflows that start with the following triggers:

  • Collection created

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 the MetafieldInput input object.

Ready to start selling with Shopify?

Try it free