Update email subscription status for an email address

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

Method Details

HTTP Methods:

PUT

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing

For a given email address and portal, update the email type subscription status.

Note: It is only possible to opt email addresses OUT of subscription and 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.
HubSpot Portal ID portalId=X - Used in the request URL The HubSpot Portal ID for the portal that you're making the call for.
Email Address :email_address - Used in the request URL The email address for which you are updating subscription status.
Optional Parameters How to use Description
JSON Body See examples Describe whether you want to unsubscribe the contact from all emails or some subset of them.

Example URL: https://api.hubapi.com/email/public/v1/subscriptions/jerry@example.org?hapikey=demo