Empfänger:innen-Objekt
Das Empfänger:innen-Objekt erlaubt es Ihnen, Informationen in unseren Endpunkten anzufragen oder zu schreiben.
Sie müssen in diesem Objekt eines der folgenden Felder angeben: external_user_id, user_alias, braze_id oder email. In der Anfrage darf nur eines angegeben werden.
Mit dem Empfänger:innen-Objekt können Sie das Nutzer-Alias-Objekt, das Trigger-Eigenschaften-Objekt, das Canvas-Eingangs-Eigenschaften-Objekt und das Nutzerattribute-Objekt kombinieren.
Objektkörper
1
2
3
4
5
6
7
8
9
10
11
[{
"user_alias": (optional, User Alias Object) User alias of user to receive message,
"external_user_id": (optional, string) see External user ID,
"braze_id": (optional, string) see Braze ID,
"email": (optional, string) email address of user to receive message,
"prioritization": (optional, array) see Prioritization; required when using email,
"trigger_properties": (optional, object) personalization key-value pairs for this user when sending a campaign or message; see Trigger Properties,
"context": (optional, object) personalization key-value pairs for this user when triggering a Canvas; see Canvas context object,
"send_to_existing_only": (optional, boolean) defaults to true; cannot be used with user aliases; if set to `false`, an `attributes` object must also be included,
"attributes": (optional, object) fields in the attributes object create or update an attribute of that name with the given value on the specified user profile before the message is sent and existing values are overwritten
}]
Wenn send_to_existing_only auf true gesetzt ist, sendet Braze die Nachricht nur an bestehende Nutzer:innen. Dieses Flag kann jedoch nicht mit Nutzer-Aliasen verwendet werden.
Wenn send_to_existing_only auf false gesetzt ist, müssen Sie im selben Empfänger:innen-Eintrag ein attributes-Objekt angeben. Das Flag ersetzt nicht attributes. Braze verwendet attributes für die Profilerstellung oder -aktualisierung vor dem Versand (z. B. um email- oder Telefonnummernfelder für E-Mail- oder SMS-Zustellung hinzuzufügen oder Abo-Gruppen zu aktualisieren). Ohne dieses Objekt erhalten Sie nicht das beabsichtigte kombinierte Verhalten für völlig neue Nutzer:innen bei /campaigns/trigger/send oder /canvas/trigger/send.
Das Profil muss weiterhin die Zielgruppen- und Kanalberechtigungsregeln der Nachricht erfüllen, bevor Braze den Versand durchführt.
Deduplizierung von Empfänger:innen-Objekten
Wenn Sie einen API-Aufruf mit dem Empfänger:innen-Objekt durchführen und ein:e doppelte:r Empfänger:in mit derselben Adresse vorhanden ist (z. B. E-Mail, Push), führt Braze eine Deduplizierung durch – das heißt, Braze entfernt identische Nutzer:innen und behält nur eine:n.
Wenn Sie beispielsweise dieselbe external_user_id verwenden, erhält die/der Nutzer:in nur eine Nachricht. Ziehen Sie mehrere API-Aufrufe in Betracht, wenn Sie dieses Verhalten umgehen möchten.
Wenn dieselbe external_user_id mehrfach im Empfänger:innen-Array vorkommt, sendet Braze nur eine Nachricht und verwendet die Trigger-Eigenschaften des letzten Vorkommens im Array. Dieses Verhalten ist deterministisch und basiert auf der Reihenfolge im Array.
Im folgenden Beispiel erhält userid1 eine Nachricht mit "name": "Beth Test 2", da dieser Eintrag als letzter im Array steht.
1
2
3
4
{"campaign_id":"#####","recipients":[
{"external_user_id":"userid1","trigger_properties":{"name":"Beth Test 1"}},
{"external_user_id":"userid1","trigger_properties":{"name":"Beth Test 2"}}
]}