generateUnsubscribeLink( )

Developer Preview

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

Creates an unsubscribe link to be shared with the relevant recipient.

If someone clicks the Unsubscribe button on the confirmation page, the recipient's subscriptionStatus is changed to UNSUBSCRIBED.

Authentication

This method may require higher-level permissions than the caller has, based on their identity and roles and permissions. In these cases, you can ensure the method is called with the required level of authorization by using one of the following:

Permissions
Manage Email Subscriptions
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
emailAddressstringRequired

Email address the unsubscribe link is for.

optionsGenerateUnsubscribeLinkOptions
Returns
Return Type:Promise<GenerateUnsubscribeLinkResponse>
Errors

This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?