About the Sender Details API

With the Sender Details API you can manage senders for email campaigns. Sender details consist of a name and a verified email address. To verify an email address, use the Sender Emails API or a Wix user can follow the process through their dashboard.

You can have multiple senders per site. Using multiple senders allows emails to come from addresses associated with specific parts of your business. For example, you could have one automated email from bookings@website.com and another from sales@website.com.

With the Sender Details API you can:

• Create, delete, and update a sender.
• Mark a sender as default and get the default sender details.
• List sender details.

Before you begin

It’s important to note the following points before starting to code:

• The first sender you create is automatically marked as the default. Only 1 sender at a time can be the default, and it's used to send emails when no other sender is specified. When you mark another sender as the default, the previous default sender is no longer the default. You can't delete the default sender. To delete it, first mark another sender as the default.
• Currently, there's a limitation when publishing an email campaign with the Campaign API. The API automatically publishes campaigns from the default sender only. Therefore, whenever you want to publish a different campaign, the appropriate sender must be set as the default.
• To add additional senders, you must have Core or Advanced email marketing plans.
• You can't have multiple senders with the same name and email address. If you want to use the same email for multiple senders, the names must be different.
• A sender's name (fromName) can't contain an email address other than the sender's own fromEmailAddress. This is checked when you create a sender and when you update fromName or fromEmailAddress. For example, if fromEmailAddress is bookings@website.com, a fromName of Bookings (sales@website.com) is rejected, while Bookings (bookings@website.com) is accepted. If you update fromEmailAddress to a different address, the new address must also be verified.

Use cases

• Publish an email campaign from a new sender

Terminology

• Sender: A combination of a verified email address and a name used to represent the source of an email campaign.
• Default sender: The sender used to send emails when no other sender is specified. Each site has 1 default sender at most.
• Campaign: A single, organized effort to send marketing emails to a list of recipients.
• Verified email: An email address that has passed the verification process with the Sender Emails API, allowing it to be used in campaigns.