curl --request POST \
--url https://api.hubapi.com/communication-preferences/v4/statuses/batch/read \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"inputs": [
"<string>"
]
}
'{
"completedAt": "2023-11-07T05:31:56Z",
"results": [
{
"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>"
}
],
"subscriberIdString": "<string>"
}
],
"startedAt": "2023-11-07T05:31:56Z",
"status": "CANCELED",
"links": {},
"requestedAt": "2023-11-07T05:31:56Z"
}Rufen Sie die Abonnementstatus für eine Reihe von Kontakten batchweise ab.
curl --request POST \
--url https://api.hubapi.com/communication-preferences/v4/statuses/batch/read \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"inputs": [
"<string>"
]
}
'{
"completedAt": "2023-11-07T05:31:56Z",
"results": [
{
"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>"
}
],
"subscriberIdString": "<string>"
}
],
"startedAt": "2023-11-07T05:31:56Z",
"status": "CANCELED",
"links": {},
"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.
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“.
Eine Liste von Zeichenfolgen, die für die Eingaben von Batch-Vorgängen stehen.
successful operation
Der Zeitpunkt (Datum und Uhrzeit), zu dem der Batch-Prozess abgeschlossen wurde.
Das Array der Ergebnisse aus dem Batch-Prozess, die jeweils Informationen zum Abonnementstatus enthalten.
Show child attributes
Der Zeitpunkt (Datum und Uhrzeit), zu dem der Batch-Prozess begann.
Der aktuelle Status des Batch-Prozesses mit den möglichen Werten: PENDING, PROCESSING, CANCELED oder COMPLETE.
CANCELED, COMPLETE, PENDING, PROCESSING Eine Sammlung von zugehörigen Links, die der Batch-Antwort zugeordnet sind.
Show child attributes
Der Zeitpunkt (Datum und Uhrzeit), zu dem die Batch-Anfrage gestellt wurde.