# 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](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::8cb15022-6129-4c62-b30b-efebb28f51a5*fallback::https://dev.wix.com/docs/rest/business-management/marketing/sender-emails/introduction) or a Wix user can follow the process [through their dashboard](fallback::https://support.wix.com/en/article/email-marketing-changing-the-sender-details-of-your-campaigns).  

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](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::4d5e036f-64fa-46ff-990a-4691faad3bd6slug::create-sender-details*fallback::https://dev.wix.com/docs/rest/business-management/marketing/sender-details/create-sender-details), [delete](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::4d5e036f-64fa-46ff-990a-4691faad3bd6slug::delete-sender-details*fallback::https://dev.wix.com/docs/rest/business-management/marketing/sender-details/delete-sender-details), and [update](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::4d5e036f-64fa-46ff-990a-4691faad3bd6slug::update-sender-details*fallback::https://dev.wix.com/docs/rest/business-management/marketing/sender-details/update-sender-details) a sender.
- [Mark a sender as default](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::4d5e036f-64fa-46ff-990a-4691faad3bd6slug::mark-sender-details-as-default*fallback::https://dev.wix.com/docs/rest/business-management/marketing/sender-details/mark-sender-details-as-default) and [get](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::4d5e036f-64fa-46ff-990a-4691faad3bd6slug::get-default-sender-details*fallback::https://dev.wix.com/docs/rest/business-management/marketing/sender-details/get-default-sender-details) the default sender details.
- [List](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::4d5e036f-64fa-46ff-990a-4691faad3bd6slug::list-sender-details*fallback::https://dev.wix.com/docs/rest/business-management/marketing/sender-details/list-sender-details) 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](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::ab11d6d2-9dcd-4600-9526-733c34cf9c24slug::publish-campaign*fallback::https://dev.wix.com/docs/rest/business-management/marketing/email-marketing/campaign/publish-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](fallback::https://support.wix.com/en/article/email-marketing-upgrading-your-email-marketing-plan).
- 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](fallback::https://dev.wix.com/docs/api-reference/business-management/marketing/emails/sender-details/sample-flows#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.

@sdk_package_setup

# Sender Details: Sample Flows

This article presents a possible use case and corresponding sample flow that you can support. It provides a useful starting point as you plan your implementation.

## Publish an email campaign from a new sender

This use case demonstrates how to send an email campaign from a new sender. For example, if a business now accepts bookings and wants to start a new email campaign, they may want to send it from a different sender, such as `Yoga Bookings: [bookings@yogawithpuppies.com]`.

Currently, there's a limitation when publishing an email campaign with the [Campaign API](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::ab11d6d2-9dcd-4600-9526-733c34cf9c24slug::publish-campaign*fallback::https://dev.wix.com/docs/rest/business-management/marketing/email-marketing/campaign/publish-campaign). The API automatically publishes campaigns only from the default sender. For this use case to work, the new sender needs to be set as the default.

> **Prerequisite:** The site must already have an [email campaign](fallback::https://support.wix.com/en/article/email-marketing-creating-and-sending-a-campaign-from-start-to-finish) to send.

To publish a campaign from a new sender:

1. Create and verify the new email address using the [Sender Emails API](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::8cb15022-6129-4c62-b30b-efebb28f51a5*fallback::https://dev.wix.com/docs/rest/business-management/marketing/sender-emails/introduction).
1. Call [Create Sender Details](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::4d5e036f-64fa-46ff-990a-4691faad3bd6slug::create-sender-details*fallback::https://dev.wix.com/docs/rest/business-management/marketing/sender-details/create-sender-details) passing the verified email address into the `fromEmailAddress` field. Also, enter the sender's name into the `fromName` field. The name can't contain an email address other than `fromEmailAddress`. Save the value of the `id` field for later use.
1. Call [Mark Sender Details as Default](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::4d5e036f-64fa-46ff-990a-4691faad3bd6slug::mark-sender-details-as-default*fallback::https://dev.wix.com/docs/rest/business-management/marketing/sender-details/mark-sender-details-as-default) and pass the saved ID.
1. Call [Publish Campaign](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::ab11d6d2-9dcd-4600-9526-733c34cf9c24slug::publish-campaign*fallback::https://dev.wix.com/docs/rest/business-management/marketing/email-marketing/campaign/publish-campaign) to send out the campaign. The campaign will automatically use the new sender details.

Mintlify Sandbox

Coding Examples

Overview

Sled Tests

Go Headless

Studio Two

Dashboard Extensions

Backend Extensions

Site Extensions

Extend Websites with SDK

Wix APIs and References

Build Apps

Wix Design System (WDS)

Client (Deprecated)

API Preview

Wix CLI

Contexts

Ricos

Extend Websites with Velo

API Reference

Velo

Picasso

Delete Sender Details