deleteInvitesWorkflow - Medusa Core Workflows Reference

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

This workflow deletes one or more user invites. It's used by the Delete Invites Admin API Route.

You can use this workflow within your customizations or your own custom workflows, allowing you to delete invites within your custom flows.

Source Code

Examples#

Steps#

Workflow hook

Step conditioned by when

View step details

Input#

DeleteInvitesWorkflowInputDeleteInvitesWorkflowInput
idsstring[]
The IDs of the invites to delete.

Emitted Events#

This section lists the events that are either triggered by the emitEventStep in the workflow, or by another workflow executed within this workflow.

You can listen to these events in a subscriber, as explained in the Subscribers documentation.

Event

Description

Payload

Action

invite.deleted

Emitted when invites are deleted.

[{
  id, // The ID of the invite
}]
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