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"
}Comprueba si un contacto ha cancelado todas las suscripciones de correo electrónico. Si un contacto no ha cancelado la suscripción a todas las comunicaciones, la matriz de respuesta results estará vacía.
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"
}Productos compatibles
Ámbitos Requeridos
The access token received from the authorization server in the OAuth 2.0 flow.
La dirección de correo electrónico del contacto.
El tipo de canal para el tipo de suscripción. Actualmente el único tipo de canal admitido es EMAIL.
EMAIL 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.
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.
successful operation
La fecha y la hora en que se completó la operación.
Una matriz que contiene los resultados de la operación.
Show child attributes
La fecha y la hora en que se inició la operación.
El estado actual de la operación, puede ser PENDIENTE, PROCESANDO, CANCELADO o COMPLETADO.
CANCELED, COMPLETE, PENDING, PROCESSING Una matriz de objetos de error que detalla cualquier problema encontrado durante la operación.
Show child attributes
Un objeto que contiene enlaces relacionados, donde cada clave es un nombre de enlace y cada valor es una URL.
Show child attributes
El número de errores encontrados durante la operación.
La fecha y hora en que se realizó la solicitud.