Account & Settings
Gerenciamento de aplicativo
Autenticação
Automação
CMS
Communication preferences
Conversas
Eventos
Arquivos
Marketing
Relatórios
Scheduler
curl --request POST \
--url https://api.hubapi.com/communication-preferences/v4/statuses/batch/unsubscribe-all/read \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"inputs": [
"<string>"
]
}
'{
"completedAt": "2023-11-07T05:31:56Z",
"results": [
{
"subscriberIdString": "<string>",
"wideStatuses": [
{
"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",
"links": {},
"requestedAt": "2023-11-07T05:31:56Z"
}Batch retrieve contacts who have opted out of all communications
Recupere o status de cancelamento de todas as assinaturas para um lote de assinantes em canais específicos. Este endpoint é útil para verificar o status de cancelamento de assinatura de vários assinantes em massa, principalmente para canais de e-mail.
curl --request POST \
--url https://api.hubapi.com/communication-preferences/v4/statuses/batch/unsubscribe-all/read \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"inputs": [
"<string>"
]
}
'{
"completedAt": "2023-11-07T05:31:56Z",
"results": [
{
"subscriberIdString": "<string>",
"wideStatuses": [
{
"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",
"links": {},
"requestedAt": "2023-11-07T05:31:56Z"
}Supported products
Supported products
Required Scopes
Required Scopes
Autorizações
The access token received from the authorization server in the OAuth 2.0 flow.
Parâmetros de consulta
O canal de comunicação para verificar o status de cancelamento de inscrição. Este parâmetro é obrigatório e atualmente só aceita 'EMAIL'.
EMAIL O ID da unidade de negócio. Este é um parâmetro opcional.
Corpo
Uma lista de strings que representam as entradas para operações em lote.
Resposta
successful operation
A data e a hora em que a solicitação em lote foi concluída.
A série de resultados do processo em lote, cada um contendo informações de status da assinatura.
Show child attributes
Show child attributes
A data e a hora em que a solicitação em lote começou.
O status atual do processo em lote, com valores possíveis: PENDING, PROCESSING, CANCELED, COMPLETE.
CANCELED, COMPLETE, PENDING, PROCESSING Uma coleção de links relacionados associados à resposta em lote.
Show child attributes
Show child attributes
A data e a hora em que a solicitação em lote foi feita.