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"
}Überprüft, ob ein Kontakt sich von allen E-Mail-Abonnements abgemeldet hat. Wenn sich ein Kontakt nicht von sämtlicher Kommunikation abgemeldet hat, ist das „results“-Array leer.
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"
}Unterstützte Produkte
Erforderliche Bereiche
The access token received from the authorization server in the OAuth 2.0 flow.
Die E-Mail-Adresse des Kontakts.
Der Kanaltyp für den Abonnementtyp. Derzeit wird nur „E-MAIL“ unterstützt.
EMAIL Wenn Sie das Add-on für Unternehmensbereiche haben, können Sie diesen Parameter einschließen, um die Ergebnisse nach der Unternehmensbereich-ID zu filtern. Der Standardunternehmensbereich des Accounts verwendet immer „0“.
Wird auf „wahr“ gesetzt, um die Details der aktualisierten Abonnementstatus in der Antwort einzuschließen. Wenn Sie diesen Parameter nicht angeben, erhalten Sie eine leere Antwort.
successful operation
Der Zeitpunkt (Datum und Uhrzeit), zu dem der Vorgang abgeschlossen wurde.
Ein Array mit den Ergebnissen aus dem Vorgang.
Show child attributes
Der Zeitpunkt (Datum und Uhrzeit), zu dem der Vorgang gestartet wurde.
Der aktuelle Status des Vorgangs: PENDING, PROCESSING, CANCELED oder COMPLETE.
CANCELED, COMPLETE, PENDING, PROCESSING Ein Array von Fehlerobjekten mit Details zu Problemen, die während des Vorgangs auftraten.
Show child attributes
Ein Objekt mit zugehörigen Links, wobei jeder Schlüssel ein Link-Name und jeder Wert eine URL ist.
Show child attributes
Die Anzahl der während des Vorgangs aufgetretenen Fehler.
Der Zeitpunkt (Datum und Uhrzeit), zu dem die Anfrage gestellt wurde.