updateCustomerGroupsWorkflow - Medusa Core Workflows Reference

This documentation provides a reference to the updateCustomerGroupsWorkflow. It belongs to the @medusajs/medusa/core-flows package.

This workflow updates one or more customer groups. It's used by the Update Customer Group Admin API Route.

You can use this workflow within your customizations or your own custom workflows, allowing you to update customer groups within your custom flows.

Examples#

updateCustomerGroupsStep

Workflow Hook

Step conditioned by when

UpdateCustomerGroupsWorkflowInputUpdateCustomerGroupsWorkflowInput

The data to update customer groups.

The filter to select the customer groups to update.

The data to update in the customer group.

UpdateCustomerGroupsWorkflowOutputUpdateCustomerGroupsWorkflowOutput

The updated customer groups.

idstring

The ID of the customer group.

namestring

The name of the customer group.

customersPartial<CustomerDTO>[]Optional

The customers of the customer group.

metadataRecord<string, unknown>Optional

Holds custom data in key-value pairs.

created_bynull | stringOptional

Who created the customer group.

deleted_atnull | string | DateOptional

The deletion date of the customer group.

created_atstring | DateOptional

The creation date of the customer group.

updated_atstring | DateOptional

The update date of the customer group.

Was this page helpful?