Menu
  • Get Started
  • Product
  • Resources
  • Tools & SDKs
  • Framework
  • Reference

refreshInviteTokensWorkflow - Medusa Core Workflows Reference

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

This workflow refreshes the token of one or more user invites, updating the token and the expiry date. It's used by the Refresh Invite Token Admin API Route.

This workflow is useful to trigger resending invite tokens. It emits the invite.resent event, which you can listen to in a Subscriber.

You can use this workflow within your customizations or your own custom workflows, allowing you to refresh invite tokens within your custom flows.

Source Code

Examples#

Steps#

refreshInviteTokensStep

emitEventStep

Workflow Hook

Step conditioned by when

Input#

ResendInvitesWorkflowInputDTOResendInvitesWorkflowInputDTO
invite_idsstring[]
The IDs of the invites to refresh.

Output#

InviteDTO[]InviteDTO[]
InviteDTOInviteDTO
The invite 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
⇧↵