restoreCampaigns - Promotion Module Reference

This documentation provides a reference to the restoreCampaigns 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.

This method restores soft deleted campaigns by their IDs.

Example#

Code
1await promotionModuleService.restoreCampaigns("procamp_123", {2  returnLinkableKeys: ["budget_id"],3})

Parameters#

campaignIdsstring | string[]

The IDs of the campaigns

configRestoreReturn<TReturnableLinkableKeys>Optional

Configurations determining which relations to restore along with each of the campaigns. You can pass to its returnLinkableKeys property any of the campaign's relation attribute names, such as budget_id.

sharedContextContextOptional

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

Returns#

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

An object that includes the IDs of related records that were restored, such as the ID of 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 the record associated with the campaign through this relation, such as the IDs of associated campaign budget. If there are no related records restored, the promise resolves to void.