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 Email API you can:
The following steps describe the process for verifying an email address using the Sender Email API:
It's important to note the following:
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.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.
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.
fromEmailAddress
field. Also, enter the sender's name into the fromName
field.Sender email ID.
Date and time when the sender email was created.
Date and time when the sender email was updated.
Sender email address.
Whether the sender email is verified.
Extensions allowing users to save custom data related to the sender emails.
{
"senderEmail": {
"id": "30057014-8ecc-4a1b-9c53-bcc7dd033bb5",
"createdDate": "2024-01-01T00:00:00.000Z",
"updatedDate": "2024-01-01T00:00:00.000Z",
"emailAddress": "john.doe@example.com",
"verified": true
}
}
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.
ID of the sender email to retrieve.
The requested sender email info.
curl 'https://www.wixapis.com/sender-emails/v1/sender-emails/30057014-8ecc-4a1b-9c53-bcc7dd033bb5' \
-H 'Authorization: <AUTH>'
{
"senderEmail": {
"id": "30057014-8ecc-4a1b-9c53-bcc7dd033bb5",
"createdDate": "2024-01-01T00:00:00.000Z",
"updatedDate": "2024-01-01T00:00:00.000Z",
"emailAddress": "john.doe@example.com",
"verified": true
}
}
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.
ID of the sender email to delete.
curl -X DELETE 'https://www.wixapis.com/sender-emails/v1/sender-emails/30057014-8ecc-4a1b-9c53-bcc7dd033bb5' \
-H 'Authorization: <AUTH>'
{}
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Retrieves a list of sender emails.
Number of items to load.
Pointer to the next or previous page in the list of results.
You can get the relevant cursor token from the pagingMetadata
object in the previous call's response.
Not relevant for the first request.
Provide a specific email address if you don't want to receive all email addresses you have.
Paging metadata.
List of sender emails.
curl 'https://www.wixapis.com/sender-emails/v1/sender-emails' \
-H 'Authorization: <AUTH>'
{
"pagingMetadata": {
"count": 2,
"cursors": {},
"hasNext": false
},
"senderEmails": [
{
"id": "30057014-8ecc-4a1b-9c53-bcc7dd033bb5",
"createdDate": "2024-01-01T00:00:00.000Z",
"updatedDate": "2024-01-01T00:00:00.000Z",
"emailAddress": "john.doe@example.com",
"verified": true
},
{
"id": "0e516e19-a95b-49e0-a3ac-6ccca4e7512a",
"createdDate": "2024-01-01T00:00:00.000Z",
"updatedDate": "2024-01-01T00:00:00.000Z",
"emailAddress": "jane.doe@example.com",
"verified": false
}
]
}
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Creates a sender email.
Sender email info.
The created sender email.
curl -X POST 'https://www.wixapis.com/sender-emails/v1/sender-emails' \
-H 'Authorization: <AUTH>' \
-H 'Content-Type: application/json' \
-d '{
"senderEmail": {
"emailAddress": "john.doe@example.com"
}
}'
{
"senderEmail": {
"id": "30057014-8ecc-4a1b-9c53-bcc7dd033bb5",
"createdDate": "2024-01-01T00:00:00.000Z",
"updatedDate": "2024-01-01T00:00:00.000Z",
"emailAddress": "john.doe@example.com",
"verified": false
}
}
There is 1 error with this status code:
There is 1 error with this status code:
See the entire list and learn more about Wix errors.
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Gets the sender email info by the email address, or creates a new one.
If you try to create an email with a name that aready exists, this endpoint won't return you an error. Instead, you'll get the info of the existing email.
Requested sender email.
The requested sender email.
curl -X POST 'https://www.wixapis.com/sender-emails/v1/sender-emails/get-or-create' \
-H 'Authorization: <AUTH>' \
-H 'Content-Type: application/json' \
-d '{
"emailAddress": "john.doe@example.com"
}'
{
"senderEmail": {
"id": "30057014-8ecc-4a1b-9c53-bcc7dd033bb5",
"createdDate": "2024-01-01T00:00:00.000Z",
"updatedDate": "2024-01-01T00:00:00.000Z",
"emailAddress": "john.doe@example.com",
"verified": true
}
}
There is 1 error with this status code:
See the entire list and learn more about Wix errors.
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Sends the verification code to your created email inbox.
Note: If you haven't received your code, check the spam folder. If it's not there, try sending the verification email again.
ID of the sender email to send the code for.
curl -X POST 'https://www.wixapis.com/sender-emails/v1/sender-emails/30057014-8ecc-4a1b-9c53-bcc7dd033bb5/send-verification-code' \
-H 'Authorization: <AUTH>' \
-H 'Content-Type: application/json' \
{}
There is 1 error with this status code:
There is 1 error with this status code:
See the entire list and learn more about Wix errors.
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Verifies a sender email by passing the verification code that you got into your inbox.
ID of the sender email to verify.
Verification code that you received in your inbox.
curl -X POST 'https://www.wixapis.com/sender-emails/v1/sender-emails/30057014-8ecc-4a1b-9c53-bcc7dd033bb5/verify' \
-H 'Authorization: <AUTH>' \
-H 'Content-Type: application/json' \
-d '{
"verificationCode": "UVSMu"
}'
{}
There is 1 error with this status code:
There is 1 error with this status code:
See the entire list and learn more about Wix errors.
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Triggered when a sender email is created.
Unique event ID. Allows clients to ignore duplicate webhooks.
Fully qualified domain name of the entity associated with the event. Expected wix.promote.v1.sender_email
.
Event name. Expected created
.
ID of the entity associated with the event.
Event timestamp.
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
If present, indicates the action that triggered the event.
Event information.
The data payload will include the following as an encoded JWT:
{
"data": {
"eventType": "wix.promote.v1.sender_email_created",
"instanceId": "<app-instance-id>",
"data": "<stringified-JSON>",
// The identity field is sent as a stringified JSON
"identity": {
"identityType": "<identityType>", // ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP
"anonymousVisitorId": "<anonymousVisitorId>", // in case of ANONYMOUS_VISITOR
"memberId": "<memberId>", // in case of MEMBER
"wixUserId": "<wixUserId>", // in case of WIX_USER
"appId": "<appId>" // in case of APP
}
}
}
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Triggered when a sender email is deleted.
Unique event ID. Allows clients to ignore duplicate webhooks.
Fully qualified domain name of the entity associated with the event. Expected wix.promote.v1.sender_email
.
Event name. Expected deleted
.
ID of the entity associated with the event.
Event timestamp.
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
If present, indicates the action that triggered the event.
Event information.
The data payload will include the following as an encoded JWT:
{
"data": {
"eventType": "wix.promote.v1.sender_email_deleted",
"instanceId": "<app-instance-id>",
"data": "<stringified-JSON>",
// The identity field is sent as a stringified JSON
"identity": {
"identityType": "<identityType>", // ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP
"anonymousVisitorId": "<anonymousVisitorId>", // in case of ANONYMOUS_VISITOR
"memberId": "<memberId>", // in case of MEMBER
"wixUserId": "<wixUserId>", // in case of WIX_USER
"appId": "<appId>" // in case of APP
}
}
}
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Triggered when a sender email is updated.
Unique event ID. Allows clients to ignore duplicate webhooks.
Fully qualified domain name of the entity associated with the event. Expected wix.promote.v1.sender_email
.
Event name. Expected updated
.
ID of the entity associated with the event.
Event timestamp.
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
If present, indicates the action that triggered the event.
Event information.
The data payload will include the following as an encoded JWT:
{
"data": {
"eventType": "wix.promote.v1.sender_email_updated",
"instanceId": "<app-instance-id>",
"data": "<stringified-JSON>",
// The identity field is sent as a stringified JSON
"identity": {
"identityType": "<identityType>", // ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP
"anonymousVisitorId": "<anonymousVisitorId>", // in case of ANONYMOUS_VISITOR
"memberId": "<memberId>", // in case of MEMBER
"wixUserId": "<wixUserId>", // in case of WIX_USER
"appId": "<appId>" // in case of APP
}
}
}