メインコンテンツへスキップ
PUT
/
email
/
public
/
v1
/
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"
}

パスパラメータ

​
email_address
string<email>
必須

The email address for which you are updating subscription status.

ボディ

application/json

Subscription update details

​
unsubscribeFromAll
boolean

Whether to unsubscribe from all emails

​
subscriptionStatuses
object[]
​
portalSubscriptionLegalBasis
enum<string>

Legal basis for portal-level subscription

利用可能なオプション:
LEGITIMATE_INTEREST_PQL,
LEGITIMATE_INTEREST_CLIENT,
PERFORMANCE_OF_CONTRACT,
CONSENT_WITH_NOTICE,
NON_GDPR
​
portalSubscriptionLegalBasisExplanation
string

Explanation for portal-level legal basis

レスポンス

Email subscription status updated successfully

​
status
string

Status of the update operation

最終更新日 2026年4月13日