deleteCampaigns - Promotion Module Reference

This documentation provides a reference to the deleteCampaigns method. This belongs to the Promotion Module.

Note: You should only use this methods when implementing complex customizations. For common cases, check out available workflows instead.

deleteCampaigns(ids, sharedContext?): Promise<void>#

This method deletes campaigns by their IDs.

Code
await promotionModuleService.deleteCampaigns(["procamp_123"])

idsstring[]

The IDs of the campaigns.

sharedContextContextOptional

A context used to share resources, such as transaction manager, between the application and the module.

PromisePromise<void>

Resolves when the campaigns are deleted successfully.

This method deletes a campaign by its ID.

Code
await promotionModuleService.deleteCampaigns("procamp_123")

idsstring

The IDs of the campaign.

sharedContextContextOptional

A context used to share resources, such as transaction manager, between the application and the module.

PromisePromise<void>

Resolves when the campaign is deleted successfully.

Was this page helpful?