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 CodeExamples#
Steps#
Input#
DeleteInvitesWorkflowInput
DeleteInvitesWorkflowInput
DeleteInvitesWorkflowInput
DeleteInvitesWorkflowInputids
string[]The IDs of the invites to delete.
ids
string[]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 |
---|---|---|---|
| Emitted when invites are deleted. |
|
Was this page helpful?