Saltar al contenido principal
POST
/
communication-preferences
/
v4
/
statuses
/
{subscriberIdString}
/
unsubscribe-all
Cancelar la suscripción de un contacto a todas las suscripciones
curl --request POST \
  --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",
      "source": "<string>",
      "status": "NOT_SPECIFIED",
      "subscriberIdString": "<string>",
      "subscriptionId": 123,
      "timestamp": "2023-11-07T05:31:56Z",
      "businessUnitId": 123,
      "legalBasis": "CONSENT_WITH_NOTICE",
      "legalBasisExplanation": "<string>",
      "setStatusSuccessReason": "NO_STATUS_CHANGE",
      "subscriptionName": "<string>"
    }
  ],
  "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"
}

Productos compatibles

Se requiere uno de los siguientes productos o productos de ediciones superiores.
Marketing HubMarketing Hub -Starter
Sales HubSales Hub -Gratuito
Service HubService Hub -Gratuito
Content HubContent Hub -Gratuito

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

La dirección de correo electrónico del contacto.

Parámetros de consulta

channel
enum<string>
requerido

El tipo de canal para el tipo de suscripción. Actualmente el único tipo de canal admitido es EMAIL.

Opciones disponibles:
EMAIL
businessUnitId
integer<int64>

Si tienes el complemento unidad de negocio, incluye este parámetro para filtrar los resultados por el ID de la unidad de negocio. La unidad de negocio predeterminada de la cuenta siempre utilizará 0.

verbose
boolean
predeterminado:false

Establecer en «true» para incluir los detalles de los estados de suscripción actualizados en la respuesta. Si no se incluye este parámetro, la respuesta será vacía.

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 de 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

Indica el estado actual de la operación, con los valores posibles: PENDIENTE, PROCESANDO, CANCELADO o COMPLETADO.

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

Una lista de errores que se produjeron durante la operación.

Contiene URL relacionadas con la respuesta, como documentación o recursos.

numErrors
integer<int32>

El número de errores que se produjeron durante la operación.

requestedAt
string<date-time>

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

Last modified on March 30, 2026