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 CodeExamples#
Steps#
Input#
ResendInvitesWorkflowInputDTO
ResendInvitesWorkflowInputDTO
ResendInvitesWorkflowInputDTO
ResendInvitesWorkflowInputDTOinvite_ids
string[]The IDs of the invites to refresh.
invite_ids
string[]Output#
InviteDTO[]
InviteDTO[]
InviteDTO[]
InviteDTO[]id
stringThe ID of the invite.
id
stringemail
stringThe email of the invite.
email
stringaccepted
booleanWhether the invite is accepted.
accepted
booleantoken
stringThe token of the invite.
token
stringexpires_at
DateThe invite's expiry date.
expires_at
Datemetadata
null | Record<string, unknown>Holds custom data in key-value pairs.
metadata
null | Record<string, unknown>created_at
DateThe invite's creation date.
created_at
Dateupdated_at
DateThe invite's update date.
updated_at
Datedeleted_at
null | DateThe invite's deletion date.
deleted_at
null | DateWas this page helpful?