Add customer metafield

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

Fields

The Add customer metafield action contains the following fields.

Fields used in the Add customer 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 customer metafield action has a hidden field added to it by the trigger. This field, Customer ID, identifies the customer to add a metafield to. The customer ID is set by default and can't be changed.

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

  • Customer created
  • Customer account enabled
  • Customer account disabled
  • Fulfillment created
  • Fulfillment event created
  • Order cancelled
  • Order created
  • Order fulfilled
  • Order paid
  • Order risk analyzed
  • Order transaction created
  • Refund created
  • Tender transaction created

Example

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

In this example workflow, a customer metafield is added to all newly created customers.

API details

To learn more, review the MetafieldInput input object.

Ready to start selling with Shopify?

Try it free