v1
Update email subscription status for an email address
Use this endpoint to update an email address’ email type subscription status or permanently unsubscribe an email address from all email. Note: If you OPT OUT of all emails or a specific email subscription type for a recipient, there is NO UNDO for this operation.
PUT
Scope requirements
Scope requirements
Path Parameters
The email address for which you are updating subscription status.
Body
application/json
Subscription update details
Whether to unsubscribe from all emails
Legal basis for portal-level subscription
Available options:
LEGITIMATE_INTEREST_PQL, LEGITIMATE_INTEREST_CLIENT, PERFORMANCE_OF_CONTRACT, CONSENT_WITH_NOTICE, NON_GDPR Explanation for portal-level legal basis
Response
Email subscription status updated successfully
Status of the update operation
Last modified on March 25, 2026