updateSenderDetails( )

Developer Preview

Updates sender details.

Description

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.

This function is not a universal function and runs only on the backend.

Admin Method

This function requires elevated permissions to run. This function is not universal and runs only on the backend.

Syntax

function updateSenderDetails(senderDetails: SenderDetails): Promise<UpdateSenderDetailsResponse>

updateSenderDetails Parameters

NAME

TYPE

DESCRIPTION

senderDetails

SenderDetails

New sender details.

Returns

Return Type:

Promise<

UpdateSenderDetailsResponse

NAME

TYPE

DESCRIPTION

verificationNeeded

boolean

Whether email address needs verification.

Was this helpful?

Updates sender details (dashboard page code)

Copy Code

1import { senderDetails } from 'wix-email-marketing.v2';
2
3// Sample object: 
4// {
5//   "senderDetails": {
6//       "fromName": "User",
7//       "fromEmail": "newemail@address.com"
8//   }
9// }
10
11export async function myUpdateSenderDetailsFunction(senderDetails) {
12    try {
13      const result = await senderDetails.updateSenderDetails;
14
15      console.log(`Success! SenderDetails updated.`)
16      return result;
17    } catch (error) {
18      console.error(error);
19    }
20}
21
22/* Promise returns:
23 * {
24 *   verificationNeeded: true
25 * }
26 */

Updates sender details (export from backend code)

Copy Code

1import { Permissions, webMethod } from 'wix-web-module';
2import { senderDetails } from 'wix-email-marketing.v2';
3
4// Sample object: 
5// {
6//   "senderDetails": {
7//       "fromName": "User",
8//       "fromEmail": "newemail@address.com"
9//   }
10// }
11
12export const myUpdateSenderDetailsFunction = webMethod(Permissions.Anyone, async (senderDetails) => {
13    try {
14      const result = await senderDetails.updateSenderDetails;
15
16      console.log(`Success! SenderDetails updated.`)
17      return result;
18    } catch (error) {
19      console.error(error);
20    }
21});
22
23/* Promise returns:
24 * {
25 *   verificationNeeded: true
26 * }
27 */
28