Update email subscription status for an email address

curl --request PUT \
  --url https://api.hubapi.com/email/public/v1/subscriptions/{email_address} \
  --header 'Content-Type: application/json' \
  --data '
{
  "unsubscribeFromAll": true
}
'

{
  "status": "ok"
}

PUT

public

subscriptions

{email_address}

curl --request PUT \
  --url https://api.hubapi.com/email/public/v1/subscriptions/{email_address} \
  --header 'Content-Type: application/json' \
  --data '
{
  "unsubscribeFromAll": true
}
'

{
  "status": "ok"
}

Scope requirements

Path Parameters

email_address

string<email>

required

The email address for which you are updating subscription status.

Body

application/json

Subscription update details

unsubscribeFromAll

boolean

Whether to unsubscribe from all emails

subscriptionStatuses

object[]

Show child attributes

portalSubscriptionLegalBasis

enum<string>

Legal basis for portal-level subscription

Available options:

LEGITIMATE_INTEREST_PQL,

LEGITIMATE_INTEREST_CLIENT,

PERFORMANCE_OF_CONTRACT,

CONSENT_WITH_NOTICE,

NON_GDPR

portalSubscriptionLegalBasisExplanation

string

Explanation for portal-level legal basis

Response

Email subscription status updated successfully

status

string

Status of the update operation

Last modified on January 28, 2026

⌘I