softDeleteCampaigns - Promotion Module Reference

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

This method soft deletes campaigns by their IDs.

Example

await promotionModuleService.softDeleteCampaigns(
  "procamp_123",
  {
    returnLinkableKeys: ["budget_id"],
  }
)

Parameters

campaignIdsstring | string[]Required

The IDs of the campaigns.

configSoftDeleteReturn<TReturnableLinkableKeys>

An object that is used to specify an entity's related entities that should be soft-deleted when the main entity is soft-deleted.

sharedContextContext

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

Returns

PromisePromise<void | Record<string, string[]>>Required

An object that includes the IDs of related records that were also soft deleted, such as the ID of the associated campaign budget. The object's keys are the ID attribute names of the campaign entity's relations, such as budget_id, and its value is an array of strings, each being the ID of a record associated with the campaign through this relation, such as the IDs of associated campaign budget. If there are no related records, the promise resolves to void.