Update customer metafield
The Update customer metafield action adds a metafield to the customer that triggers the workflow, or updates an existing metafield on that customer.
Fields
The Update customer metafield action contains the following fields.
| 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 | The data type of the metafield's value. |
Triggers
The Update 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 Update customer metafield can be used in workflows that start with the following triggers:
- Customer account disabled
- Customer account enabled
- Customer created
- Fulfillment created
- Fulfillment event created
- Order canceled
- Order created
- Order fulfilled
- Order paid
- Order risk analyzed
- Order transaction created
- Refund created
- Subscription contract created
- Tender transaction created
Example
In this example workflow, a customer metafield is added to all newly created customers.
API details
To learn more, review the MetafieldInput input object.