Skip to content

Abfrage der Liste der abgemeldeten E-Mail-Adressen

get

/email/unsubscribes

Verwenden Sie diesen Endpunkt, um die letzten E-Mails zurückzugeben, die im Zeitraum von start_date bis end_date abgemeldet wurden. Für einen vollständigen Verlauf des Abo-Status verwenden Sie Currents, um diese Daten zu verfolgen.

Sie können diesen Endpunkt verwenden, um eine bidirektionale Synchronisierung zwischen Braze und anderen E-Mail-Systemen oder Ihrer eigenen Datenbank einzurichten.

See me in Postman

Voraussetzungen

Um diesen Endpunkt zu verwenden, benötigen Sie einen API-Schlüssel mit der Berechtigung email.unsubscribe.

Rate-Limit

Wir wenden auf diesen Endpunkt das standardmäßige Braze-Rate-Limit von 250.000 Anfragen pro Stunde an, wie in API-Rate-Limits dokumentiert.

Anfrageparameter

Parameter Erforderlich Datentyp Beschreibung
start_date Optional
(siehe Anmerkung)		 String im Format JJJJ-MM-TT Startdatum des Bereichs zum Abrufen der Abmeldungen. Muss vor end_date liegen. Dies wird von der API als Mitternacht in UTC-Zeit behandelt.
end_date Optional
(siehe Anmerkung)		 String im Format JJJJ-MM-TT Enddatum des Bereichs zum Abrufen der Abmeldungen. Dies wird von der API als Mitternacht in UTC-Zeit behandelt.
limit Optional Integer Optionales Feld zur Begrenzung der Anzahl der zurückgegebenen Ergebnisse. Standardwert ist 100, Maximum ist 500.
offset Optional Integer Optionaler Anfangspunkt in der Liste, ab dem abgerufen werden soll.
sort_direction Optional String Geben Sie den Wert asc ein, um die Abmeldungen von den ältesten zu den neuesten zu sortieren. Geben Sie desc ein, um von den neuesten zu den ältesten zu sortieren. Wenn sort_direction nicht angegeben ist, ist die Standardreihenfolge von den neuesten zu den ältesten.
email Optional
(siehe Anmerkung)		 String Falls angegeben, wird zurückgegeben, ob sich die Nutzer:in abgemeldet hat oder nicht.

Wenn Ihr Datumsbereich mehr als limit Abmeldungen enthält, müssen Sie mehrere API-Aufrufe tätigen und dabei jedes Mal den offset erhöhen, bis ein Aufruf entweder weniger als limit oder null Ergebnisse zurückgibt.

Beispielanfrage

1
2

curl --location --request GET 'https://rest.iad-01.braze.com/email/unsubscribes?start_date=2020-01-01&end_date=2020-02-01&limit=1&offset=1&sort_direction=desc&[email protected]' \
--header 'Authorization: Bearer YOUR-API-KEY-HERE'

Antwort

Einträge werden in absteigender Reihenfolge aufgelistet.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

{
  "emails": [
    {
      "email": (string) an email that has been unsubscribed,
      "unsubscribed_at": (string) the time the email was unsubscribed in ISO 8601
    },
    {
      "email": (string) an email that has been unsubscribed,
      "unsubscribed_at": (string) the time the email was unsubscribed in ISO 8601
    },
    {
      "email": (string) an email that has been unsubscribed,
      "unsubscribed_at": (string) the time the email was unsubscribed in ISO 8601
    }
  ],
  "message": "success"
}
New Stuff!