With the Sender Details API you can manage senders for your email campaigns. Sender details consist of a name and an email address, where the email address must be verified through the Sender Emails API beforehand.
You can have multiple senders per site. Using multiple senders allows your letters 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:
It's important to note the following:
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 send an email campaign from a new sender. For example, if your business now accepts bookings and you want to start a new email campaign, you'll need to send it from a different sender, such as Yoga Bookings: [bookings@yogawithpuppies.com]
.
Notes:
To publish a campaign from a new sender:
fromEmailAddress
field. Also, enter the sender's name into the fromName
field. Save the value of id
field for later use.Sender details ID.
Date and time when the sender details were created.
Date and time when the sender details were updated.
Sender name. This name appears in the email as "from:" name.
Sender email address. Recipients can also reply to this email address.
Whether the sender is default.
Extensions allowing users to save custom data related to the sender details.
{
"senderDetails": {
"id": "3dcaeca5-2b09-441c-86ab-808d85061511",
"createdDate": "2024-01-01T00:00:00.000Z",
"updatedDate": "2024-01-01T00:00:00.000Z",
"fromName": "John Doe",
"fromEmailAddress": "john.doe@example.com",
"default": true
}
}
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Retrieves sender details by ID.
Sender details ID.
The requested sender details.
curl 'https://www.wixapis.com/sender-details/v1/sender-details/3dcaeca5-2b09-441c-86ab-808d85061511' \
-H 'Authorization: <AUTH>'
{
"senderDetails": {
"id": "3dcaeca5-2b09-441c-86ab-808d85061511",
"createdDate": "2024-01-01T00:00:00.000Z",
"updatedDate": "2024-01-01T00:00:00.000Z",
"fromName": "John Doe",
"fromEmailAddress": "john.doe@example.com",
"default": 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.
Note: You can't delete a default sender.
ID of the sender to delete.
curl -X DELETE 'https://www.wixapis.com/sender-details/v1/sender-details/a6351a69-f4cb-411c-9853-26634468b03d' \
-H 'Authorization: <AUTH>'
{}
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.
Retrieves default sender details.
Default sender details.
curl 'https://www.wixapis.com/sender-details/v1/sender-details/default' \
-H 'Authorization: <AUTH>'
{
"senderDetails": {
"id": "3dcaeca5-2b09-441c-86ab-808d85061511",
"createdDate": "2024-01-01T00:00:00.000Z",
"updatedDate": "2024-01-01T00:00:00.000Z",
"fromName": "John Doe",
"fromEmailAddress": "john.doe@example.com",
"default": 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.
Retrieves a list of sender details.
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.
Paging metadata.
List of sender details.
curl 'https://www.wixapis.com/sender-details/v1/sender-details' \
-H 'Authorization: <AUTH>'
{
"pagingMetadata": {
"count": 2,
"cursors": {},
"hasNext": false
},
"senderDetails": [
{
"id": "3dcaeca5-2b09-441c-86ab-808d85061511",
"createdDate": "2024-01-01T00:00:00.000Z",
"updatedDate": "2024-01-01T00:00:00.000Z",
"fromName": "John Doe",
"fromEmailAddress": "john.doe@example.com",
"default": true
},
{
"id": "a6351a69-f4cb-411c-9853-26634468b03d",
"createdDate": "2024-01-01T00:00:00.000Z",
"updatedDate": "2024-01-01T00:00:00.000Z",
"fromName": "Jane Doe",
"fromEmailAddress": "jane.doe@example.com",
"default": 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.
Sender details to create.
The created sender details.
curl -X POST 'https://www.wixapis.com/sender-details/v1/sender-details' \
-H 'Authorization: <AUTH>' \
-H 'Content-Type: application/json' \
-d '{
"senderDetails": {
"fromName": "John Doe",
"fromEmailAddress": "john.doe@example.com",
}
}'
{
"senderDetails": {
"id": "3dcaeca5-2b09-441c-86ab-808d85061511",
"createdDate": "2024-01-01T00:00:00.000Z",
"updatedDate": "2024-01-01T00:00:00.000Z",
"fromName": "John Doe",
"fromEmailAddress": "john.doe@example.com",
"default": true
}
}
There is 1 error with this status code:
There are 2 errors 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.
Updates a sender.
Sender details ID.
Sender details to update.
The updated sender details.
curl -X PATCH 'https://www.wixapis.com/sender-details/v1/sender-details/3dcaeca5-2b09-441c-86ab-808d85061511' \
-H 'Authorization: <AUTH>' \
-H 'Content-Type: application/json' \
-d '{
"senderDetails": {
"fromName": "Johnny Doe",
"fromEmailAddress": "john.doe@example.com"
}
}'
{
"senderDetails": {
"id": "3dcaeca5-2b09-441c-86ab-808d85061511",
"createdDate": "2024-01-01T00:00:00.000Z",
"updatedDate": "2024-01-02T00:00:00.000Z",
"fromName": "Johnny Doe",
"fromEmailAddress": "john.doe@example.com",
"default": true
}
}
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.
Marks a sender as default.
ID of the sender to mark as default.
curl -X POST 'https://www.wixapis.com/sender-details/v1/sender-details/a6351a69-f4cb-411c-9853-26634468b03d/mark-as-default' \
-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.
Triggered when a sender 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_details
.
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_details_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
}
}
}
{
"id": "9c47296f-349a-4154-828a-dd9ae68ebaba",
"entityFqdn": "wix.promote.v1.sender_details",
"slug": "created",
"entityId": "3dcaeca5-2b09-441c-86ab-808d85061511",
"createdEvent": {
"entity": {
"id": "3dcaeca5-2b09-441c-86ab-808d85061511",
"createdDate": "2024-01-01T00:00:00.000Z",
"updatedDate": "2024-01-01T00:00:00.000Z",
"fromName": "John Doe",
"fromEmailAddress": "john.doe@example.com",
"default": true
}
},
"eventTime": "2024-01-01T00:00:00.000000000Z",
"triggeredByAnonymizeRequest": false,
"entityEventSequence": "1"
}
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 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_details
.
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_details_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
}
}
}
{
"id": "f072b4a7-6f70-4ffc-9faf-bc79ec21175b",
"entityFqdn": "wix.promote.v1.sender_details",
"slug": "deleted",
"entityId": "3dcaeca5-2b09-441c-86ab-808d85061511",
"deletedEvent": {
"movedToTrash": true
},
"eventTime": "2024-01-01T00:00:00.000000000Z",
"triggeredByAnonymizeRequest": false,
"entityEventSequence": "15"
}
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
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_details
.
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_details_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
}
}
}
{
"id": "cd46f8e2-32ea-4d62-9534-88cd6dc17dca",
"entityFqdn": "wix.promote.v1.sender_details",
"slug": "updated",
"entityId": "3dcaeca5-2b09-441c-86ab-808d85061511",
"updatedEvent": {
"currentEntity": {
"id": "3dcaeca5-2b09-441c-86ab-808d85061511",
"createdDate": "2024-01-01T00:00:00.000Z",
"updatedDate": "2024-01-02T00:00:00.000Z",
"fromName": "Johnny Doe",
"fromEmailAddress": "john.doe@example.com",
"default": true
}
},
"eventTime": "2024-01-02T00:00:00.000000000Z",
"triggeredByAnonymizeRequest": false,
"entityEventSequence": "2"
}