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 ruta

email_address

string<email>

requerido

The email address for which you are updating subscription status.

Cuerpo

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

Opciones disponibles:

LEGITIMATE_INTEREST_PQL,

LEGITIMATE_INTEREST_CLIENT,

PERFORMANCE_OF_CONTRACT,

CONSENT_WITH_NOTICE,

NON_GDPR

portalSubscriptionLegalBasisExplanation

string

Explanation for portal-level legal basis

Respuesta

Email subscription status updated successfully

status

string

Status of the update operation

Última modificación el 3 de abril de 2026

View subscriptions timeline for a portal

Conversations API

⌘I

Cuenta y configuración

Gestión de aplicaciones

Autenticación

Automatización

CMS

Preferencias de comunicación

Conversaciones

CRM

Eventos

Archivos

Marketing

Crear informes

Programador

Webhooks

Update email subscription status for an email address

Parámetros de ruta

Cuerpo

Respuesta