Sender Details Object

Attributes
fromNamestring
Display name of sender.

fromEmailstringformat EMAIL
Email address of sender.

dateVerifiedstringRead-onlyformat date-time
Date and time the sender's email address was verified.
Was this helpful?
Yes
No

GetGet Sender Details

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 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.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Email Marketing
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Endpoint
GET
https://www.wixapis.com/email-marketing/v1/sender-details

Was this helpful?
Yes
No

PatchUpdate Sender Details

Developer Preview

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

Updates sender details (only provided fields will be updated).

If from_email is changed - a verification code will be sent to new email address. If verification is needed, a verification email will be sent to the user, and verification_needed will return true.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Email Marketing
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Endpoint
PATCH
https://www.wixapis.com/email-marketing/v1/sender-details

Event TriggersThis method triggers the following events:
Was this helpful?
Yes
No

PostVerify 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.

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

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Email Marketing
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Endpoint
POST
https://www.wixapis.com/email-marketing/v1/sender-details/verify-email

Event TriggersThis method triggers the following events:
Was this helpful?
Yes
No

PostResolve Actual From Address

Developer Preview

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

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

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Email Marketing
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Endpoint
POST
https://www.wixapis.com/email-marketing/v1/sender-details/actual-from-address

Was this helpful?
Yes
No

Sender Details Updated

Developer Preview

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

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

Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring
Unique event ID. Allows clients to ignore duplicate webhooks.

entityFqdnstring
Fully qualified domain name of the entity associated with the event. Expected wix.email_marketing.v1.sender_details.

slugstring
Event name. Expected updated.

entityIdstring
ID of the entity associated with the event.

eventTimestringformat date-time
Event timestamp.

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

originatedFromstring
If present, indicates the action that triggered the event.

updatedEventobject
Event information.
Was this helpful?
Yes
No