Skip to content

Abo-Gruppen von Nutzer:innen auflisten

get

/subscription/user/status

Verwenden Sie diesen Endpunkt, um die Abo-Gruppen mit dem Verlauf bestimmter Nutzer:innen aufzulisten und abzurufen.

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.groups.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
external_id Erforderlich String Die external_id der Nutzer:in (muss mindestens eine und darf höchstens 50 external_ids enthalten).
email Erforderlich* String Die E-Mail-Adresse der Nutzer:in. Kann als String-Array übergeben werden. Es muss mindestens eine E-Mail-Adresse angegeben werden (maximal 50).
phone Erforderlich* String im E.164-Format Die Telefonnummer der Nutzer:in. Es muss mindestens eine Telefonnummer angegeben werden (maximal 50).
limit Optional Integer Das Limit für die maximale Anzahl der zurückgegebenen Ergebnisse. Standard (und Maximum) für limit ist 100.
offset Optional Integer Anzahl der Templates, die übersprungen werden sollen, bevor die restlichen Templates zurückgegeben werden, die den Suchkriterien entsprechen.

Beispielanfrage

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

1
2

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

Beispielantwort

Nur Abo-Gruppen, für die im Verlauf einer Nutzer:in ein Update des Abo-Status erfolgt ist, werden in einer erfolgreichen Antwort berücksichtigt. Das bedeutet, dass neu erstellte Abo-Gruppen nicht aufgelistet werden.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

{
    "users": [
        {
            "email": "[email protected]",
            "phone": "50505050",
            "external_id": "20500",
            "subscription_groups": [
                {
                  "id": "ec2fcc919fca",
                  "name": "ActivationGroup",
                  "channel": "email",
                  "status": "Subscribed"
                },
                {
                  "id": "7d7af9dd5556",
                  "name": "ReactivationGroup",
                  "channel": "email",
                  "status": "Subscribed"
                },
                {
                  "id": "a5e84fd16220",
                  "name": "MarketingGroup",
                  "channel": "sms",
                  "status": "Unsubscribed"
                },
                {
                  "id": "64d8cad9176c",
                  "name": "TransactionalGroup",
                  "channel": "sms",
                  "status": "Unsubscribed"
                },
                {
                  "id": "b2134cd63942",
                  "name": "BankerMarketingGroup",
                  "channel": "sms",
                  "status": "Subscribed"
                }
            ]
        }
    ],
    "total_count": 1,
    "message": "success"
}
New Stuff!