curl --request GET \
--url https://api.hubapi.com/communication-preferences/2026-03/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"
}Verifique se um contato cancelou a assinatura de todas as assinaturas de e-mail. Se um contato não tiver optado por não receber todas as comunicações, a matriz de “resultados” da resposta estará vazia.
curl --request GET \
--url https://api.hubapi.com/communication-preferences/2026-03/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"
}Supported products
Required Scopes
The access token received from the authorization server in the OAuth 2.0 flow.
O identificador exclusivo do assinante cujo status de cancelamento de inscrição está sendo recuperado.
O canal de comunicação para cancelar a inscrição. Deve ser 'EMAIL'.
EMAIL O ID da unidade de negócio associada às preferências de comunicação.
Um booleano que indica se informações detalhadas devem ser incluídas na resposta. O padrão é falso.
successful operation
A data e a hora em que a operação foi concluída.
Uma série contendo os resultados da operação.
Show child attributes
A data e a hora em que a operação começou.
O status atual da operação, que pode ser PENDING, PROCESSING, CANCELED ou COMPLETE.
CANCELED, COMPLETE, PENDING, PROCESSING Uma série de objetos de erro detalhando quaisquer problemas encontrados durante a operação.
Show child attributes
Um objeto que contém links relacionados, onde cada chave é um nome de link e cada valor é um URL.
Show child attributes
O número de erros encontrados durante a operação.
A data e a hora em que a solicitação foi feita.