Skip to content

Abo-Gruppenstatus der Nutzer:innen auflisten

get

/subscription/status/get

Verwenden Sie diesen Endpunkt, um den Abo-Status einer Nutzer:in in einer Abo-Gruppe abzurufen.

Diese Gruppen sind auf der Seite Abo-Gruppe verfügbar. Die Antwort dieses Endpunkts enthält die externe ID sowie den Status „Abonniert“, „Abgemeldet“ oder „Unbekannt“ für die im API-Aufruf angeforderte Abo-Gruppe. Dies kann verwendet werden, um den Abo-Gruppenstatus in nachfolgenden API-Aufrufen zu aktualisieren oder auf einer gehosteten Webseite anzuzeigen.

Wenn Sie E-Mails über ein angepasstes Formular erfassen und dann die Abo-Gruppenmitgliedschaft über die REST API festlegen, rufen Sie diesen Endpunkt zuerst auf, um zu prüfen, ob bereits ein Profil vorhanden ist. Wenn kein übereinstimmendes Profil existiert, erstellen oder abonnieren Sie die Nutzer:in mit dem Endpunkt Abo-Gruppenstatus der Nutzer:innen aktualisieren. Andernfalls aktualisieren Sie das vorhandene Profil, anstatt ein Duplikat zu erstellen. Weitere Erfassungsmuster finden Sie unter Best Practices für die Datenerfassung.

Wenn Sie Beispiele sehen oder diesen Endpunkt für E-Mail-Abo-Gruppen testen möchten:

See me in Postman

Wenn Sie Beispiele sehen oder diesen Endpunkt für SMS-Abo-Gruppen testen möchten:

See me in Postman

Wenn Sie Beispiele sehen oder diesen Endpunkt für WhatsApp-Gruppen testen möchten:

See me in Postman

Voraussetzungen

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

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
subscription_group_id Erforderlich String Die id Ihrer Abo-Gruppe.
external_id Erforderlich* String Die external_id der Nutzer:in (muss mindestens eine und höchstens 50 external_ids enthalten).

Wenn sowohl eine external_id als auch email/phone übermittelt werden, werden nur die angegebenen external_id(s) auf die Ergebnisabfrage angewendet.
email Erforderlich* String Die E-Mail-Adresse der Nutzer:in. Kann als String-Array mit maximal 50 Einträgen übergeben werden.

Die gleichzeitige Übermittlung einer E-Mail-Adresse und einer Telefonnummer (ohne external_id) führt zu einem Fehler.
phone Erforderlich* String im E.164-Format Die Telefonnummer der Nutzer:in. Wenn keine E-Mail angegeben wird, müssen Sie mindestens eine Telefonnummer angeben (maximal 50).

Die gleichzeitige Übermittlung einer E-Mail-Adresse und einer Telefonnummer (ohne external_id) führt zu einem Fehler.

*Für jede Nutzer:in ist entweder external_id, email oder phone erforderlich.

  • Für SMS- und WhatsApp-Abo-Gruppen ist entweder external_id oder phone erforderlich. Wenn beide übermittelt werden, wird nur die external_id für die Abfrage verwendet und die Telefonnummer wird dieser Nutzer:in zugeordnet.
  • Für E-Mail-Abo-Gruppen ist entweder external_id oder email erforderlich. Wenn beide übermittelt werden, wird nur die external_id für die Abfrage verwendet und die E-Mail-Adresse wird dieser Nutzer:in zugeordnet.

Beispielanfrage

1

https://rest.iad-03.braze.com/subscription/status/get?subscription_group_id={{subscription_group_id}}&external_id[]=1&external_id[]=2

1
2

curl --location -g --request GET 'https://rest.iad-01.braze.com/subscription/status/get?subscription_group_id={{subscription_group_id}}&phone=+11112223333' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'

Antwort

Alle erfolgreichen Antworten geben je nach Status und Verlauf der Nutzer:innen mit der Abo-Gruppe Subscribed, Unsubscribed oder Unknown zurück.

1
2
3
4
5
6
7

{
  "status": {
    "1": "Unsubscribed",
    "2": "Subscribed"
  },
  "message": "success"
}
New Stuff!