acceptInviteWorkflow - Medusa Core Workflows Reference

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

This workflow accepts an invite and creates a user. It's used by the Accept Invite Admin API Route.

The workflow throws an error if the specified token is not valid. Also, the workflow requires an auth identity to be created previously. You can create an auth identity using the Retrieve Registration JWT Token API Route.

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

Source Code

Examples#

Steps#

Input#

AcceptInviteWorkflowInputDTOAcceptInviteWorkflowInputDTO
invite_tokenstring
The invite token.
auth_identity_idstring
The ID of the auth identity to associate the user with.
userobject
The user to create.

Output#

UserDTO[]UserDTO[]
UserDTOUserDTO
The user details.
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