- Get Started
- Product
- Resources
- Tools & SDKs
- Framework
- Reference
Menu
- Get Started
- Product
- Resources
- Tools & SDKs
- Framework
- Reference
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
Input#
AcceptInviteWorkflowInputDTO
AcceptInviteWorkflowInputDTO
AcceptInviteWorkflowInputDTO
AcceptInviteWorkflowInputDTOinvite_token
stringThe invite token.
invite_token
stringauth_identity_id
stringThe ID of the auth identity to associate the user with.
auth_identity_id
stringuser
objectThe user to create.
user
objectOutput#
Was this page helpful?