About Sender Emails

Developer Preview
APIs in Developer Preview are subject to change and are not intended for use in production.
Send us your suggestions for improving this API. Your feedback is valuable to us.

 

When sending an email campaign, you are required to confirm your email address to ensure that your letter reaches its destination. With the Sender Email API, you can create and verify "from" and "reply-to" email addresses for your email campaign. Once verified, these emails are used to create and manage different senders using the Sender Details API.

With the Sender Emails API you can:

Sender email verification flow

The following steps describe the process for verifying an email address using the Sender Email API:

  1. Call Create Sender Email and specify the email address you'd like to use.
  2. Call Send Verification Code and check your inbox for the verification code.
  3. Use the received verification code to call Verify Sender Email and verify the email address.

Before you begin

It's important to note the following:

  • You'll get the verification code to the email address you specify, so ensure you have access to that inbox.
  • If you haven't received your code, check the spam folder. If it's not there, try sending the verification email again.
  • Usually, your verified email address will be used as both the "from" and "reply-to" address. However, there are cases where campaigns are sent from an authenticated address owned by Wix:
    • When your verified email uses a publicly available mailbox provider domain, such as @gmail, @yahoo, or @outlook. For example, if your email is pianosinfo@gmail.com it will appear as the "reply-to" address, while the "from" address will be something like pianos@pb01.wixemails.com or pianos@wixsiteautomations.com. This ensures that your email reaches your recipients' inbox rather than their junk folder or being rejected entirely.
    • When the domain of your verified email is not properly authenticated and has a strict DMARC policy configured.

Use Cases and Flows

Terminology

  • Campaign: A single, organized effort to send marketing emails to a list of recipients.
  • Sender Email: The "sent from" email address used in email campaigns.
  • Reply-to Email: The email address where recipients can send their replies to a marketing campaign.
Did this help?

Sender Email: Use Cases and Flows

This article presents possible use cases and corresponding sample flows that your app can support. It provides a useful starting point as you plan your app's implementation.

Add a new sender to your email campaign

This use case demonstrates how to add a new sender to your email campaign. In this example, your business now accepts bookings and you want to start a new email campaign, where the new sender's email address is bookings@website.com.

Note: This flow assumes you already have the Core or Advanced Email Marketing plans.

  1. Call Create Sender Email and specify the email address you'd like to set as a sender’s email address.
  2. Call Send Verification Code and check your inbox for the verification code.
  3. Use the received verification code to call Verify Sender Email and verify the email address.
  4. Call Create Sender Details passing the verified email address into the fromEmailAddress field. Also, enter the sender's name into the fromName field.
Did this help?

Sender Email Object

Properties
idstringRead-onlyformat GUID

Sender email ID.

createdDatestringRead-onlyformat date-time

Date and time when the sender email was created.

updatedDatestringRead-onlyformat date-time

Date and time when the sender email was updated.

emailAddressstringformat EMAILminLength 6maxLength 254

Sender email address.

verifiedbooleanRead-only

Whether the sender email is verified.

extendedFieldsExtendedFields

Extensions allowing users to save custom data related to the sender emails.

SenderEmail
JSON
Did this help?
GET

Get Sender Email

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves a sender email by ID.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Access Verticals by Automations
Set Up Automations
Learn more about app permissions.
Endpoint
GET
https://www.wixapis.com/sender-emails/v1/sender-emails/{senderEmailId}
Path Params
senderEmailIdstringRequired

ID of the sender email to retrieve.

Response Object
senderEmailSenderEmail

The requested sender email info.

Get Sender Email Example 1
Request
cURL
Response
JSON
Errors

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

Did this help?
DELETE

Delete Sender Email

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Deletes a sender email.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Access Verticals by Automations
Set Up Automations
Learn more about app permissions.
Endpoint
DELETE
https://www.wixapis.com/sender-emails/v1/sender-emails/{senderEmailId}
Path Params
senderEmailIdstringRequired

ID of the sender email to delete.

Response Object
Returns an empty object.
Delete Sender Email Example 1
Request
cURL
Response
JSON
Errors

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

Event TriggersThis method triggers the following events:
Sender Email Deleted
Did this help?