deleteCampaign( )

Developer Preview

Permanently deletes a campaign.

Description

This function is not a universal function and runs only on the backend.

Admin Method

This function requires elevated permissions to run. This function is not universal and runs only on the backend.

Syntax

function deleteCampaign(campaignId: string): Promise<void>

deleteCampaign Parameters

NAME

TYPE

DESCRIPTION

campaignId

string

Campaign ID.

Returns

Return Type:

Promise<

void

Was this helpful?

Permanently deletes a campaign (dashboard page code)

Copy Code

1import { campaigns } from 'wix-email-marketing.v2';
2
3//  Sample campaignId value: "fb21c999-40b5-4364-8e75-18273da41983";
4
5export async function myDeleteCampaignFunction(campaignId) {
6  try {
7    const result = await campaigns.deleteCampaign(campaignId);
8      
9    console.log(`Campaign ${campaignId} successfully deleted`)
10    return result;
11  } catch (error) {
12    console.error(error);
13  }
14}
15
16/* Promise resolves to void */

Permanently deletes a campaign (export from backend code)

Copy Code

1import { Permissions, webMethod } from 'wix-web-module';
2import { campaigns } from 'wix-email-marketing.v2';
3
4//  Sample campaignId value: "fb21c999-40b5-4364-8e75-18273da41983";
5
6export const myDeleteCampaignFunction = webMethod(Permissions.Anyone, async (campaignId) => {
7  try {
8    const result = await campaigns.deleteCampaign(campaignId);
9      
10    console.log(`Campaign ${campaignId} successfully deleted`)
11    return result;
12  } catch (error) {
13    console.error(error);
14  }
15});
16
17/* Promise resolves to void */
18