createInvitesWorkflow - Medusa Core Workflows Reference

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

This workflow creates one or more user invites. It's used by the Create Invite Admin API Route.

You can use this workflow within your customizations or your own custom workflows, allowing you to create invites within your custom flows.

Examples#

Steps#

Input#

Output#

Emitted Events#

This section lists the events that are either triggered by the emitEventStep in the workflow, or by another workflow executed within this workflow.

You can listen to these events in a subscriber, as explained in the Subscribers documentation.

[{
  id, // The ID of the invite
}]