Empfänger:innen-Objekt
Mit dem Empfänger:innen-Objekt können Sie Informationen in unseren Endpunkten anfragen oder schreiben.
Sie müssen in diesem Objekt eines der folgenden Felder angeben: external_user_id, user_alias, braze_id oder email. Anfragen dürfen nur eines davon angeben.
Mit dem Empfänger:innen-Objekt können Sie das Nutzer-Alias-Objekt, das Trigger-Eigenschaften-Objekt, das Canvas-Entry-Eigenschaften-Objekt und das Nutzerattribute-Objekt kombinieren.
Objektkörper
[{
"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. Sie können dieses Flag jedoch nicht mit Nutzer-Aliasen verwenden.
Wenn send_to_existing_only auf false gesetzt ist, müssen Sie für dieselbe Empfänger:in ein attributes-Objekt angeben. Das Flag ersetzt attributes nicht. Braze verwendet attributes, um das Profil vor dem Versand zu erstellen oder zu aktualisieren (zum Beispiel, um email- oder Telefonfelder für die E-Mail- oder SMS-Zustellung hinzuzufügen oder Abo-Gruppen zu aktualisieren). Ohne dieses Objekt erhalten Sie für neue Nutzer:innen nicht das beabsichtigte kombinierte Verhalten bei /campaigns/trigger/send oder /canvas/trigger/send.
Dieses Profil muss weiterhin die Regeln der Nachricht für Zielgruppe und Kanalberechtigung erfüllen, bevor Braze die Nachricht sendet.
Deduplizierung von Empfänger-Objekten
Wenn Sie einen API-Aufruf mit dem Empfänger-Objekt durchführen, dedupliziert Braze die Nutzer:in, falls ein:e doppelte:r Empfänger:in dieselbe Adresse (also E-Mail, Push) anspricht. Das bedeutet, dass Braze identische Nutzer:innen entfernt und nur eine:n behält.
Wenn Sie beispielsweise dieselbe external_user_id verwenden, erhält die Nutzer:in nur eine Nachricht. Wenn Sie dieses Verhalten umgehen müssen, sollten Sie mehrere API-Aufrufe durchführen.
Wenn dieselbe external_user_id mehrmals im Array recipients vorkommt, sendet Braze nur eine Nachricht und verwendet die Trigger-Eigenschaften aus dem letzten Vorkommen 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.
{"campaign_id":"#####","recipients":[
{"external_user_id":"userid1","trigger_properties":{"name":"Beth Test 1"}},
{"external_user_id":"userid1","trigger_properties":{"name":"Beth Test 2"}}
]}