removeMarketingConsent( )

Developer Preview

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

Removes a marketing consent. The consent is cancelled, and the state is updated to REVOKED. The marketing consent entity still exists, but the recipient is no longer eligible to receive commmunication. To delete a marketing consent entirely, use Delete Marketing Consent.

Required fields:

  • details.type.
  • details.email OR details.phone.
  • info.lastRevokeActivity.
Authentication

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

Permissions
Manage Marketing Consents
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
detailsMarketingConsentDetailsRequired

Marketing consent communication details.

optionsRemoveMarketingConsentOptions

Field options. The lastRevokeActivity field must be passed.

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