Update email subscription status for an email address

Last updated April 16, 2019

PUT /email/public/v1/subscriptions/:email_address

Method Details

HTTP Methods:


Content Type:


Response Format:


Requires Authentication?


Rate Limited?






For a given email address, update the email type subscription status, or permanently unsubscribe an email address from all email.

The subscription status is tied to the email address, and not a specific contact record. Because of this, it is possible to update the status for an email address even if there is not currently a contact with that email address. If the status is updated for an email address not currently associated with a contact, and a contact is later created, the email eligibility of the updated email address will apply to the new contact. The same would be true if there was an existing contact, and the contact was deleted, and a new contact with the same email address was created.

Note: If you OPT OUT of all emails or a specific email subscription type for a recipient, there is NO UNDO for this operation.

Required Parameters How to use Description
OAuth Access Token or API Key Authorization: Bearer {token} header
or hapikey={key} query parameter.
Used to authenticate the request. Please see this page for more details about authentication.
Email Address :email_address - Used in the request URL The email address for which you are updating subscription status.
JSON Body See examples Describe whether you want to unsubscribe the email address from all emails or some subset of them. If you want to record the legal basis for GDPR, you can select from "LEGITIMATE_INTEREST_PQL", "LEGITIMATE_INTEREST_CLIENT", "PERFORMANCE_OF_CONTRACT", "CONSENT_WITH_NOTICE", or "NON_GDPR". The explanation is free-form text noting any specific consent information you wish to record.
optState Used in the JSON Body Determines whether a contact is opted in or out of a given email subscription. The possible values are "OPT_IN", "OPT_OUT", and "NOT_OPTED"