Go Headless

Build Apps

Client

API Preview

Ricos

Develop Websites

REST

Velo

GraphQL (Alpha)

Retrieves sender details.

The sender details include the information displayed as the email sender's name and email address.

+ If you send an email campaign with a public email domain (e.g. @gmail.com or @yahoo.com), the email address will not be displayed in the 'from' header. Instead, the email address is replaced with @wixemails.com (or @wixsitemail.com for free users), and the sender's email is placed in the 'reply-to' header.

+ If you send an email campaign with an email from a Wix managed domain, that email will be displayed in the 'from' header.

+ If you send an email from a custom domain that is not managed by Wix, a line will be inserted that states that the email was sent via wixemails.com.

import { senderDetails } from '@wix/email-marketing';

async function getSenderDetails() {
  const response = await senderDetails.getSenderDetails();
};

getSenderDetails: Wix-hosted

import { createClient } from '@wix/sdk';
import { senderDetails } from '@wix/email-marketing';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { senderDetails },
  // Include the auth strategy and host as relevant
});


async function getSenderDetails() {
  const response = await myWixClient.senderDetails.getSenderDetails();
};

Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).

getSenderDetails: Self-hosted

getSenderDetails

Manage Email Marketing

GetSenderDetailsResponse

User's provided address from which to send email marketing campaign.

fromAddress

string

Checks if the sender's email address will be used as from-address or replaced (not related to current sender details).

import { senderDetails } from '@wix/email-marketing';

async function resolveActualFromAddress(fromAddress) {
  const response = await senderDetails.resolveActualFromAddress(fromAddress);
};

resolveActualFromAddress: Wix-hosted

import { createClient } from '@wix/sdk';
import { senderDetails } from '@wix/email-marketing';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { senderDetails },
  // Include the auth strategy and host as relevant
});


async function resolveActualFromAddress(fromAddress) {
  const response = await myWixClient.senderDetails.resolveActualFromAddress(fromAddress);
};

resolveActualFromAddress: Self-hosted

resolveActualFromAddress

ResolveActualFromAddressResponse

senderDetails

SenderDetails

Updates sender details.

If the `fromEmail` is changed, a verification code will be sent to the new email address.

If verification is needed, a verification email will be sent to the user, and the returned `verificationNeeded` value will be `true`.

import { senderDetails } from '@wix/email-marketing';

async function updateSenderDetails(senderDetails) {
  const response = await senderDetails.updateSenderDetails(senderDetails);
};

updateSenderDetails: Wix-hosted

import { createClient } from '@wix/sdk';
import { senderDetails } from '@wix/email-marketing';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { senderDetails },
  // Include the auth strategy and host as relevant
});


async function updateSenderDetails(senderDetails) {
  const response = await myWixClient.senderDetails.updateSenderDetails(senderDetails);
};

updateSenderDetails: Self-hosted

updateSenderDetails

UpdateSenderDetailsResponse

verificationCode

Verifies the sender's email using a verification code sent to the user's email address upon update.

import { senderDetails } from '@wix/email-marketing';

async function verifyEmail(verificationCode) {
  const response = await senderDetails.verifyEmail(verificationCode);
};

verifyEmail: Wix-hosted

import { createClient } from '@wix/sdk';
import { senderDetails } from '@wix/email-marketing';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { senderDetails },
  // Include the auth strategy and host as relevant
});


async function verifyEmail(verificationCode) {
  const response = await myWixClient.senderDetails.verifyEmail(verificationCode);
};

verifyEmail: Self-hosted

verifyEmail

void

---
title: Introduction
---

# About Sender Details 

The Sender Details API contains the information that is displayed as the sender’s name and email address when sending an email from your Wix site. 

With the Sender Details API you can: 
- [Get](email-marketing/sender-details/get-sender-details) your email sender details.
- [Update](email-marketing/sender-details/update-sender-details) your email sender details.
- [Verify](email-marketing/sender-details/verify-email) your sender email address.

## Before you begin

Before you begin, it is important to note the following information. 

If you send an email campaign with a public email domain (e.g. @gmail.com or @yahoo.com), the email address isn't displayed in the 'from' header. Instead, the email address is replaced with @wixemails.com (or @wixsitemail.com for free users), and the sender's email is placed in the 'reply-to' header.

If you send an email campaign with an email from a Wix managed domain, that email will be displayed in the 'from' header. If you send an email from a custom domain that is not managed by Wix, a line will be inserted that states that the email was sent via wixemails.com.

To use the SenderDetails API, install the `@wix/email-marketing` package using npm or Yarn:
  ```console
npm install @wix/email-marketing
```

or

```console
yarn add @wix/email-marketing
```

Then import `{ senderDetails }` from `@wix/email-marketing`:

```js
import { senderDetails } from '@wix/email-marketing'
```
  

email-marketing_sender-details

EventMetadata

Unique event ID.
Allows clients to ignore duplicate webhooks.

A sequence number defining the order of updates to the underlying entity.
For example, given that some entity was updated at 16:00 and than again at 16:01,
it is guaranteed that the sequence number of the second update is strictly higher than the first.
As the consumer, you can use this value to ensure that you handle messages in the correct order.
To do so, you will need to persist this number on your end, and compare the sequence number from the
message against the one you have stored. Given that the stored number is higher, you should ignore the message.

entityEventSequence

Assumes actions are also always typed to an entity_type
Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction

entityFqdn

ID of the entity associated with the event.

entityId

Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z

eventTime

eventType

The identification type and identity data.

identity

IdentificationData

instanceId

If present, indicates the action that triggered the event.

originatedFrom

This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
This is although the created/updated/deleted notion is duplication of the oneof types
Example: created/updated/deleted/started/completed/email_opened

slug

Whether the event was triggered as a result of a privacy regulation application
(for example, GDPR).

triggeredByAnonymizeRequest

boolean

ID of a site visitor that has not logged in to the site.

anonymousVisitorId

appId

ID of a site visitor that has logged in to the site.

memberId

ID of a Wix user (site owner, contributor, etc.).

wixUserId

identityType

WebhookIdentityType

OnSenderDetailsUpdatedHandler

event

SenderDetailsUpdatedEnvelope

Actual from-address that will be used for email distribution.

actualFromAddress

Date and time the sender's email address was verified.

dateVerified

fromEmail

fromName

entity

metadata

Whether email address needs verification.

verificationNeeded

handler

An event that triggers when sender details are updated without the need for explicit verification.

import { senderDetails } from '@wix/email-marketing';

senderDetails.onSenderDetailsUpdated((event) => {
    // handle your event here
});

onSenderDetailsUpdated: Wix-hosted

import { createClient, AppStrategy } from '@wix/sdk';
import { senderDetails } from '@wix/email-marketing';

const wixClient = createClient({
  auth: AppStrategy({
    appId: 'MY-APP-ID',
    publicKey: 'YOUR_APP_PUBLIC_KEY',
   }),
   modules: {
      senderDetails,
    },
});

wixClient.senderDetails.onSenderDetailsUpdated((event) => {
    // handle your event here
});

onSenderDetailsUpdated( )