Subscription preferences

Access and test APIs in beta. 

Please note: This API is currently under development and is subject to change based on testing and feedback. By using these endpoints you agree to adhere to our Developer Developer Beta Terms of Use. You also acknowledge and understand the risk associated with testing an unstable API. 
 

 For the latest stable version, check out this page.

Subscriptions types represent the lawful basis to communicate with your contacts through email. Contacts can manage their email preferences so they're only opted in to emails they want to receive.

 

Get contact subscription status

The contact subscription status endpoint allows users to retrieve the subscription statuses for an email address in an account.

This endpoint is ideal for when you have an external preferences center or integration and need to know the subscription statuses for any given email address in your account.


Subscribe contact

The subscribe contact endpoint allows you to subscribe an email address to any given subscription type in an account, but will not allow you to resubscribe contacts who have opted out. 

Example use case: This endpoint is ideal for when you have an integration or external form that needs to opt contacts into a subscription type. 

Note: The subscribe contact endpoint should only be used to honor requests from contacts who have given you permission to subscribe them. Please review applicable laws and regulations before resubscribing a contact. 


Unsubscribe contact

The unsubscribe contact endpoint allows allows you to unsubscribe an email address in an account from any given subscription type. 

Example use case: This endpoint is ideal for when you have an integration or external form that needs to opt contacts out of a subscription type.


Get subscription types

The subscription info endpoint allows users to retrieve all subscription types in their account.

Example use case: This endpoint is ideal for when you have an external preferences center, integration, or form and need to know which subscription types exist in your account so you can update the subscription statuses for your contacts accordingly.