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"
}

{
  "status": "<string>",
  "message": "<string>",
  "correlationId": "<string>"
}

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"
}

{
  "status": "<string>",
  "message": "<string>",
  "correlationId": "<string>"
}

Scope requirements

Parâmetros de caminho

email_address

string<email>

obrigatório

The email address for which you are updating subscription status.

Corpo

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

Opções disponíveis:

LEGITIMATE_INTEREST_PQL,

LEGITIMATE_INTEREST_CLIENT,

PERFORMANCE_OF_CONTRACT,

CONSENT_WITH_NOTICE,

NON_GDPR

portalSubscriptionLegalBasisExplanation

string

Explanation for portal-level legal basis

Resposta

Email subscription status updated successfully

status

string

Status of the update operation

Última modificação em 10 de abril de 2026

View subscriptions timeline for a portal

Conversations API

⌘I

Conta e configurações

Gerenciamento de aplicativo

Autenticação

Automação

CMS

Preferências de comunicação

Conversas

CRM

Eventos

Arquivos

Marketing

Relatórios

Agendador

Webhooks

Update email subscription status for an email address

Parâmetros de caminho

Corpo

Resposta