About Campaign API

With the Campaign API you can manage and publish email marketing campaigns that have already been created by a Wix user.

With the Campaign API you can:

• Retrieve statistics and recipients of a campaign.
• Retrieve information about the campaign.
• Publish a campaign and send it out to predefined contacts.
• Send a test email.
• Reschedule a campaign to send it a different time.
• Reuse an existing campaign so that a Wix user doesn't have to rebuild it from scratch.

Creating a campaign

To create a campaign, a Wix user must either design a template from scratch or use one of the pre-made templates available in the Wix dashboard. The API does not support campaign creation.

After the campaign is created, your app can send a test email to preview how it will appear in an inbox. We strongly recommend you calling the Send Test method only a few times in a row. There's a rate limit to prevent the abusing of the method.

Publishing a campaign

To publish a campaign, you need to set up sender details. You can publish the campaign from the default sender only. Therefore, whenever you want to publish a different campaign, the appropriate sender must be set as the default. To determine which email address will be used as the "From" address, call Identify Sender Address. Campaigns can only be sent to Wix site contacts.

It's possible to schedule a campaign when publishing it. You can schedule the campaign no less than 30 minutes until the sending time. A Wix user needs to upgrade the plan to schedule the campaign.

When a campaign is published, you'll also receive a URL for the campaign's landing page, which can be shared on social media.

A campaign can also be published without sending emails. In this case, only the campaign landing page URL will be provided.

A Wix user can be blocked from using Wix Email Marketing if they don't comply with the Wix Email Marketing Terms of Use.

Before you begin

• Each Wix site has an email limit. The limit depends on the email marketing plan.

Use cases

• A/B Testing for Subject Lines and Call-to-Action (CTA) Buttons

Terminology

• Campaign: A marketing message designed to be distributed to an audience with email.
• Template: A predefined structure for creating campaigns. Templates include placeholders that can be replaced with specific values to customize the content.
• Audience: The group of recipients targeted by a campaign.
• Campaign scheduling: The process of setting a specific date and time for when a campaign will be sent. Requires at least 30 minutes' notice before the scheduled send time.
• Label: A tag that allows Wix users to organize and group contacts.