# About the 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](fallback::https://dev.wix.com/docs/rest/business-management/marketing/email-marketing/campaign/list-statistics) and [recipients](fallback::https://dev.wix.com/docs/rest/business-management/marketing/email-marketing/campaign/list-recipients) of a campaign.
- [Retrieve](fallback::https://dev.wix.com/docs/rest/business-management/marketing/email-marketing/campaign/get-campaign) information about the campaign.
- [Publish](fallback::https://dev.wix.com/docs/rest/business-management/marketing/email-marketing/campaign/publish-campaign) a campaign and send it out to predefined contacts.
- Send a [test email](fallback::https://dev.wix.com/docs/rest/business-management/marketing/email-marketing/campaign/send-test).
- [Reschedule](fallback::https://dev.wix.com/docs/rest/business-management/marketing/email-marketing/campaign/reschedule) a campaign to send it at a different time.
- [Reuse](fallback::https://dev.wix.com/docs/rest/business-management/marketing/email-marketing/campaign/reuse-campaign) 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, you can send a test email to preview how it will appear in an inbox. We strongly recommend calling the [Send Test](fallback::https://dev.wix.com/docs/rest/business-management/marketing/email-marketing/campaign/send-test) method only a few times in a row. There's a rate limit to prevent abuse of the method.

## Publishing a campaign

To publish a campaign, [sender details](fallback::https://dev.wix.com/docs/rest/business-management/marketing/sender-details/introduction) need to be set up. You can only publish the campaign to come from the default sender. 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](fallback::https://dev.wix.com/docs/rest/business-management/marketing/email-marketing/campaign/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 before the sending time. A Wix user needs to [upgrade the plan](fallback::https://support.wix.com/en/article/email-marketing-upgrading-your-email-marketing-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](fallback::https://www.wix.com/shoutout/terms-of-use).

## Before you begin

- Each Wix site has an email limit. The limit depends on the [email marketing plan](fallback::https://support.wix.com/en/article/email-marketing-upgrading-your-email-marketing-plan).

## Use cases

- [A/B testing for subject lines and call-to-action (CTA) buttons](fallback::https://dev.wix.com/docs/rest/business-management/marketing/email-marketing/campaign/sample-use-cases-and-flows)

## 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.

# Sample Flows and Use Cases

This article presents a possible use case and corresponding sample flow you can support. This can be a helpful jumping off point as you plan your implementation.

## A/B testing for subject lines and call-to-action (CTA) buttons

You can help a Wix user run an A/B test on the subject of their new email campaign. For example, a marketing company wants to test different subject lines and CTA buttons to determine which performs better in terms of open rates and conversions. They use a robust, multi-phase A/B testing approach to fine-tune the effectiveness of their campaigns.

> **Note:** This flow assumes you have already created and published an email marketing campaign with a couple variations of the subject line and CTA buttons.

1. Call [List Campaigns](fallback::https://dev.wix.com/docs/rest/business-management/marketing/email-marketing/campaign/list-campaigns) to retrieve the campaign IDs for both campaigns. Save the values for later use.
1. Call [List Statistics](fallback::https://dev.wix.com/docs/rest/business-management/marketing/email-marketing/campaign/list-statistics) and pass the campaign IDs for each campaign. Track the open rates and click-through rates for each campaign variation.
1. Based on the results from the A/B tests, call [List Recipients](fallback::https://dev.wix.com/docs/rest/business-management/marketing/email-marketing/campaign/list-recipients) by the `"CLICKED"` activity.
1. Call [Label Contact](fallback::https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/label-contact) to label the best-performing recipients. Save these contacts for later use.
1. Adjust the campaign content based on the most successful subject lines and CTAs. If certain combinations perform better, prioritize those for the next phase of the campaign.
1. Call [Publish Campaign](fallback::https://dev.wix.com/docs/rest/business-management/marketing/email-marketing/campaign/publish-campaign) to send the refined campaign to the selected audience.
1. After the campaign goes live, continuously monitor results by calling [List Statistics](fallback::https://dev.wix.com/docs/rest/business-management/marketing/email-marketing/campaign/list-statistics) to evaluate whether the refined versions outperform the initial variations.

Coding Examples

Sled Tests

Go Headless

Build Apps

Client

API Preview

Ricos

Develop Websites

REST

Velo

Picasso

GraphQL (Alpha)