deleteCustomerGroupsWorkflow - Medusa Core Workflows Reference

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

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

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

Examples#

deleteCustomerGroupStep

Workflow Hook

Step conditioned by when

DeleteCustomerGroupsWorkflowInputDeleteCustomerGroupsWorkflowInput

The data to delete customer groups.

idsstring[]

The IDs of the customer groups to delete.

Was this page helpful?