Saltar al contenido principal
GET
/
communication-preferences
/
v4
/
statuses
/
{subscriberIdString}
/
unsubscribe-all
Recuperar el estado de cancelación de suscripción de un contacto
curl --request GET \
  --url https://api.hubapi.com/communication-preferences/v4/statuses/{subscriberIdString}/unsubscribe-all \
  --header 'Authorization: Bearer <token>'
{
  "completedAt": "2023-11-07T05:31:56Z",
  "results": [
    {
      "channel": "EMAIL",
      "status": "NOT_SPECIFIED",
      "subscriberIdString": "<string>",
      "timestamp": "2023-11-07T05:31:56Z",
      "wideStatusType": "BUSINESS_UNIT_WIDE",
      "businessUnitId": 123
    }
  ],
  "startedAt": "2023-11-07T05:31:56Z",
  "status": "CANCELED",
  "errors": [
    {
      "category": "<string>",
      "context": {},
      "errors": [
        {
          "message": "<string>",
          "code": "<string>",
          "context": "{missingScopes=[scope1, scope2]}",
          "in": "<string>",
          "subCategory": "<string>"
        }
      ],
      "links": {},
      "message": "<string>",
      "status": "<string>",
      "id": "<string>",
      "subCategory": {}
    }
  ],
  "links": {},
  "numErrors": 123,
  "requestedAt": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://developers.hubspot.es/docs/llms.txt

Use this file to discover all available pages before exploring further.

Supported products

Autorizaciones

Authorization
string
header
requerido

The access token received from the authorization server in the OAuth 2.0 flow.

Parámetros de ruta

subscriberIdString
string
requerido

El identificador único del suscriptor cuyo estado de cancelación de suscripción se está obteniendo.

Parámetros de consulta

channel
enum<string>
requerido

El canal de comunicación del que se cancelará la suscripción. Debe ser "EMAIL".

Opciones disponibles:
EMAIL
businessUnitId
integer<int64>

El ID de la unidad de negocio. Este es un parámetro entero opcional.

verbose
boolean
predeterminado:false

Un valor booleano que indica si se debe incluir información detallada en la respuesta. De forma predeterminada, es falso.

Respuesta

successful operation

completedAt
string<date-time>
requerido

La fecha y la hora en que se completó la operación.

results
object[]
requerido

Una matriz que contiene los resultados de la operación.

startedAt
string<date-time>
requerido

La fecha y la hora en que se inició la operación.

status
enum<string>
requerido

El estado actual de la operación, puede ser PENDIENTE, PROCESANDO, CANCELADO o COMPLETADO.

Opciones disponibles:
CANCELED,
COMPLETE,
PENDING,
PROCESSING
errors
object[]

Una matriz de objetos de error que detalla cualquier problema encontrado durante la operación.

Un objeto que contiene enlaces relacionados, donde cada clave es un nombre de enlace y cada valor es una URL.

numErrors
integer<int32>

El número de errores encontrados durante la operación.

requestedAt
string<date-time>

La fecha y hora en que se realizó la solicitud.

Last modified on April 13, 2026