Get Started
Product
Resources
Tools & SDKs
Framework
Reference

linkCustomersToCustomerGroupWorkflow - Medusa Core Workflows Reference

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

This workflow manages the customers of a customer group. It's used by the Manage Customers of Group Admin API Route.

You can use this workflow within your customizations or your own custom workflows, allowing you to manage the customers of a customer group within your custom flows.

Source Code

Examples#

Steps#

linkCustomersToCustomerGroupStep

Workflow Hook

Step conditioned by when

Input#

LinkWorkflowInputLinkWorkflowInput

idstring

The ID of the data model to create links to or remove links from.

addstring[]Optional

The IDs of the other data models to create links to the record specified in id.

removestring[]Optional

The IDs of the other data models to remove links from the record specified in id.

Was this page helpful?