deleteCampaignsWorkflow - Medusa Core Workflows Reference

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

This workflow deletes one or more campaigns. It's used by the Delete Campaign Admin API Route.

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

Examples#

Steps#

Input#

Hooks#

Hooks allow you to inject custom functionalities into the workflow. You'll receive data from the workflow, as well as additional data sent through an HTTP request.

Learn more about Hooks and Additional Data.

campaignsDeleted#

This step is a hook that you can inject custom functionality into.

Example

Code
1import { deleteCampaignsWorkflow } from "@medusajs/medusa/core-flows"2
3deleteCampaignsWorkflow.hooks.campaignsDeleted(4  (async ({ ids }, { container }) => {5    //TODO6  })7)

Input

Handlers consuming this hook accept the following input.