pauseScheduling( )

Developer Preview

Pauses a scheduled campaign.

Description

Learn more about market campaign scheduling.

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 pauseScheduling(campaignId: string): Promise<void>

pauseScheduling Parameters

NAME

TYPE

DESCRIPTION

campaignId

string

Campaign ID.

Returns

Return Type:

Promise<

void

Was this helpful?

Pauses a scheduled campaign (dashboard page code)

Copy Code

1import { campaigns } from 'wix-email-marketing.v2';
2
3// Sample campaignId = "ea46013c-bbbf-4617-ad5d-9247bc4c0970";
4
5export async function myPauseSchedulingFunction(campaignId) {
6  try {
7    const result = campaigns.pauseScheduling(campaignId);
8
9    console.log(`Success! Your campaign id: ${campaignId} has been paused.`)
10    return result;
11  } catch (error) {
12    console.error(error);
13  }
14}
15
16/* Promise returns void */

Pauses a scheduled 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 = "ea46013c-bbbf-4617-ad5d-9247bc4c0970";
5
6export const myPauseSchedulingFunction = webMethod(Permissions.Anyone, async (campaignId) => {
7  try {
8    const result = campaigns.pauseScheduling(campaignId);
9
10    console.log(`Success! Your campaign id: ${campaignId} has been paused.`)
11    return result;
12  } catch (error) {
13    console.error(error);
14  }
15});
16
17/* Promise returns void */