Objet destinataires

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

Vous devez inclure l’un des éléments suivants dans cet objet : external_user_id, user_alias, braze_id ou email. Les requêtes ne doivent en spécifier qu’un seul.

L’objet destinataires 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 de 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; 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
}]

Lorsque send_to_existing_only est true, Braze envoie uniquement le message aux utilisateurs existants. Cependant, vous ne pouvez pas utiliser cet indicateur avec des alias d’utilisateur.

Lorsque send_to_existing_only est false, vous devez inclure un objet attributes pour le même destinataire. L’indicateur ne remplace pas attributes. Braze utilise attributes pour créer ou mettre à jour le profil avant l’envoi (par exemple pour ajouter email ou des champs de numéro de téléphone pour la distribution par e-mail ou SMS, ou pour mettre à jour les groupes d’abonnement). Sans cet objet, vous n’obtenez pas le comportement combiné attendu pour les nouveaux utilisateurs sur /campaigns/trigger/send ou /canvas/trigger/send.

Ce profil doit toujours respecter les règles d’éligibilité d’audience et de canal du message avant que Braze ne l’envoie.

• ID Braze
• Alias d’utilisateur
• ID utilisateur externe
• Priorisation
• Objet d’attributs utilisateur

Déduplication de l’objet destinataire

Lorsque vous effectuez un appel API avec l’objet destinataire, s’il existe un destinataire en double ciblant la même adresse (par exemple, e-mail, notification push), Braze déduplique l’utilisateur. Autrement dit, Braze supprime les utilisateurs identiques pour n’en conserver qu’un seul.

Par exemple, si vous utilisez le même external_user_id, l’utilisateur ne reçoit 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 de déclencheur de la dernière occurrence du tableau. Ce comportement est déterministe et repose sur l’ordre du tableau.

Dans l’exemple suivant, userid1 reçoit un seul message utilisant "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"}}
]}