Menu

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.

Source Code

Examples#

Steps#

createInviteStep

emitEventStep

Workflow hook

Step conditioned by when

View step details

Input#

CreateInvitesWorkflowInputDTOCreateInvitesWorkflowInputDTO
invitesCreateInviteDTO[]
The invites to create.

Output#

InviteDTO[]InviteDTO[]
idstring
The ID of the invite.
emailstring
The email of the invite.
acceptedboolean
Whether the invite is accepted.
tokenstring
The token of the invite.
expires_atDate
The invite's expiry date.
metadatanull | Record<string, unknown>
Holds custom data in key-value pairs.
created_atDate
The invite's creation date.
updated_atDate
The invite's update date.
deleted_atnull | Date
The invite's deletion date.
Was this page helpful?
Ask Anything
FAQ
What is Medusa?
How can I create a module?
How can I create a data model?
How do I create a workflow?
How can I extend a data model in the Product Module?
Recipes
How do I build a marketplace with Medusa?
How do I build digital products with Medusa?
How do I build subscription-based purchases with Medusa?
What other recipes are available in the Medusa documentation?
Chat is cleared on refresh
Line break
⇧↵