removeCustomerAccountWorkflow - Medusa Core Workflows Reference
This documentation provides a reference to the removeCustomerAccountWorkflow
. It belongs to the @medusajs/medusa/core-flows
package.
This workflow deletes a customer and remove its association to its auth identity. It's used by the Delete Customer Admin API Route.
You can use this workflow within your customizations or your own custom workflows, allowing you to delete customer accounts within your custom flows.
Examples#
Steps#
Workflow hook
Step conditioned by when
View step details
Input#
RemoveCustomerAccountWorkflowInput
RemoveCustomerAccountWorkflowInput
RemoveCustomerAccountWorkflowInput
RemoveCustomerAccountWorkflowInputcustomerId
string
customerId
stringOutput#
string
string
string
stringstring
string
string
stringEmitted 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 a customer is deleted. |
|