validateTokenStep - Medusa Core Workflows Reference

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

This step validates a specified token and returns its associated invite. If not valid, the step throws an error.

src/workflows/my-workflow.ts
1import { createWorkflow } from "@medusajs/framework/workflows-sdk"2import { validateTokenStep } from "@medusajs/medusa/core-flows"3
4const myWorkflow = createWorkflow(5  "my-workflow",6  () => {7    const data = validateTokenStep("{value}")8  }9)

Input#

stringstring
stringstring

Output#

InviteDTOInviteDTO
The invite details.
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