curl --request POST \
--url https://api.hubapi.com/communication-preferences/v4/statuses/batch/unsubscribe-all \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"inputs": [
"<string>"
]
}
'{
"completedAt": "2023-11-07T05:31:56Z",
"results": [
{
"subscriberIdString": "<string>",
"statuses": [
{
"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"
}Cancele a assinatura de um conjunto de contatos de todas as assinaturas de e-mail.
curl --request POST \
--url https://api.hubapi.com/communication-preferences/v4/statuses/batch/unsubscribe-all \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"inputs": [
"<string>"
]
}
'{
"completedAt": "2023-11-07T05:31:56Z",
"results": [
{
"subscriberIdString": "<string>",
"statuses": [
{
"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"
}Produtos suportados
Escopos Necessários
The access token received from the authorization server in the OAuth 2.0 flow.
O tipo de canal para o tipo de assinatura. Atualmente, o único tipo de canal suportado é "E-MAIL".
EMAIL Se você tiver o complemento de unidade de negócios, inclua este parâmetro para filtrar os resultados por ID de unidade de negócios. A unidade de negócios padrão da conta sempre usará "0".
Defina como "true" para incluir os detalhes dos status de assinatura atualizados na resposta. Não incluir esse parâmetro resultará em uma resposta vazia.
Uma lista de strings que representam as entradas para operações em lote.
successful operation
A data e a hora em que a operação de opt-out em massa foi concluída.
Uma série contendo os resultados de opt-out em massa de todas as operações de comunicação.
Show child attributes
A data e a hora em que a operação de opt-out em massa começou.
O status atual da operação de opt-out em massa, 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 de opt-out em massa.
Show child attributes
Uma coleção de URLs com links para recursos ou documentação relacionados.
Show child attributes
O número total de erros encontrados durante a operação de opt-out em massa.
A data e a hora em que a solicitação de opt-out em massa foi feita.