Objet Destinataire

L’objet Destinataire vous permet de demander ou d’écrire des informations dans nos endpoints.

Vous devez inclure external_user_id, user_alias, braze_id ou email dans cet objet. Les demandes ne doivent en spécifier qu’un seul.

L’objet Destinataire vous permet de combiner l’objet alias d’utilisateur, l’objet propriétés du déclencheur, l’objet propriétés d’entrée Canvas et l’objet attributs utilisateur.

Corps de l’objet

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,
  "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
}]

Lorsque send_to_existing_only est défini sur true, Braze envoie le message uniquement aux utilisateurs existants. Cependant, il n’est pas possible d’utiliser ce paramètre avec les alias d’utilisateurs. Lorsque send_to_existing_only est défini sur false, vous devez inclure un attribut. Braze crée alors un utilisateur avec l’id et les attributs avant d’envoyer le message.

• ID Braze
• Alias d’utilisateurs
• ID utilisateur externe
• Priorisation
• Objet Attributs utilisateur

Déduplication de l’objet Destinataire

Lorsqu’un appel API est effectué avec l’objet Destinataire, s’il existe un destinataire en double ciblant la même adresse (c’est-à-dire e-mail, push), Braze procède à la déduplication de l’utilisateur, ce qui signifie que les doublons sont supprimés et qu’un seul est conservé.

Par exemple, si vous utilisez le même external_user_id, l’utilisateur ne recevra qu’un seul message. Si vous avez besoin de contourner ce comportement, envisagez d’effectuer plusieurs appels API.

Lorsque le même external_user_id apparaît plusieurs fois dans le tableau des destinataires, Braze n’envoie qu’un seul message et utilise les propriétés du déclencheur de la dernière occurrence dans le tableau. Ce comportement est déterministe et basé sur l’ordre du tableau.

Dans l’exemple suivant, userid1 reçoit un seul message avec "name": "Beth Test 2", car cette entrée apparaît en dernier dans le tableau.

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"}}
]}