sendTest( )

Sends a test email. Call this method to preview your email campaign.

We strongly recommend calling this method only a few times in a row, as there is a rate limit to prevent abuse of the Send Test method.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user's permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Access Verticals by Automations
Set Up Automations
Manage Email Marketing
Manage Stores
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
campaignIdstringRequired

Campaign ID.

optionsSendTestOptions

Options for sending a test email.

Errors

This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?