updateSenderDetails( )


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.

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.

Admin Method

This function requires elevated permissions and runs only on the backend and on dashboard pages.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Email Marketing
Learn more about permission scopes.
Method Declaration
Copy
Method Parameters
senderDetailsSenderDetailsRequired

New sender details.

Returns
Return Type:Promise<UpdateSenderDetailsResponse>
Was this helpful?
Yes
No