Search...
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';23// Sample object:4// {5// "senderDetails": {6// "fromName": "User",7// "fromEmail": "newemail@address.com"8// }9// }1011export async function myUpdateSenderDetailsFunction(senderDetails) {12 try {13 const result = await senderDetails.updateSenderDetails;1415 console.log(`Success! SenderDetails updated.`)16 return result;17 } catch (error) {18 console.error(error);19 }20}2122/* Promise returns:23 * {24 * verificationNeeded: true25 * }26 */
Updates sender details (export from backend code)
Copy Code
1import { Permissions, webMethod } from 'wix-web-module';2import { senderDetails } from 'wix-email-marketing.v2';34// Sample object:5// {6// "senderDetails": {7// "fromName": "User",8// "fromEmail": "newemail@address.com"9// }10// }1112export const myUpdateSenderDetailsFunction = webMethod(Permissions.Anyone, async (senderDetails) => {13 try {14 const result = await senderDetails.updateSenderDetails;1516 console.log(`Success! SenderDetails updated.`)17 return result;18 } catch (error) {19 console.error(error);20 }21});2223/* Promise returns:24 * {25 * verificationNeeded: true26 * }27 */28