sendTest( )

Developer Preview

Sends a test email for preview purposes.

Description

It is heavily throttled, so don't use this for regular campaign sending.

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 sendTest(campaignId: string, options: SendTestOptions): Promise<void>

sendTest Parameters

NAME

TYPE

DESCRIPTION

campaignId

string

Campaign ID.

options

Optional

SendTestOptions

Options for sending a test email.

Returns

Return Type:

Promise<

void

Was this helpful?

Sends a test email campaign for preview purposes (dashboard page code)

Copy Code

1import { campaigns } from 'wix-email-marketing.v2';
2
3// Sample campaignId = "ea46013c-bbbf-4617-ad5d-9247bc4c0970";
4
5// Sample options value:
6//   {
7//     "emailSubject": "Hello",
8//     "toEmailAddress": "clientname@email.com",
9//     "language": "en",
10//     "placeholders": {},
11//     "fromName": "User",
12//     "replyToEmailAddress": "yourname@wix.com"
13//   }
14
15export async function mySendTestFunction(campaignId, options) {
16  try {
17    const result = await campaigns.sendTest(campaignId, options);
18
19    console.log("Success! Your test campaign has been sent.")
20    // return result;
21  } catch (error) {
22    console.error(error);
23  }
24}
25
26/* Promise returns void */

Sends a test email campaign for preview purposes (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
6// Sample options value:
7//   {
8//     "emailSubject": "Hello",
9//     "toEmailAddress": "clientname@email.com",
10//     "language": "en",
11//     "placeholders": {},
12//     "fromName": "User",
13//     "replyToEmailAddress": "yourname@wix.com"
14//   }
15
16export const mySendTestFunction = webMethod(Permissions.Anyone, async (campaignId, options) => {
17  try {
18    const result = await campaigns.sendTest(campaignId, options);
19
20    console.log("Success! Your test campaign has been sent.")
21    // return result;
22  } catch (error) {
23    console.error(error);
24  }
25});
26
27/* Promise returns void */
28