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 CodeExamples#
Steps#
Workflow hook
Step conditioned by when
View step details
Input#
AcceptInviteWorkflowInputDTOAcceptInviteWorkflowInputDTO
AcceptInviteWorkflowInputDTOAcceptInviteWorkflowInputDTOinvite_tokenstringThe invite token.
invite_tokenstringauth_identity_idstringThe ID of the auth identity to associate the user with.
auth_identity_idstringuserobjectThe user to create.
userobjectOutput#
UserDTO[]UserDTO[]
UserDTO[]UserDTO[]idstringThe ID of the user.
idstringemailstringThe email of the user.
emailstringfirst_namenull | stringThe first name of the user.
first_namenull | stringlast_namenull | stringThe last name of the user.
last_namenull | stringavatar_urlnull | stringThe avatar URL of the user.
avatar_urlnull | stringmetadatanull | Record<string, unknown>Holds custom data in key-value pairs.
metadatanull | Record<string, unknown>created_atDateThe creation date of the user.
created_atDateupdated_atDateThe updated date of the user.
updated_atDatedeleted_atnull | DateThe deletion date of the user.
deleted_atnull | DateWas this page helpful?