Objeto de destinatarios
El objeto de destinatarios te permite solicitar o escribir información en nuestros endpoints.
Debes incluir uno de external_user_id, user_alias, braze_id o email en este objeto. Las solicitudes deben especificar solo uno.
El objeto de destinatarios te permite combinar el objeto de alias de usuario, el objeto de propiedades del desencadenador, el objeto de propiedades de entrada de Canvas y el objeto de atributos de usuario.
Cuerpo del objeto
[{
"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
}]
Cuando send_to_existing_only es true, Braze solo envía el mensaje a usuarios existentes. Sin embargo, no puedes usar este indicador con alias de usuario.
Cuando send_to_existing_only es false, debes incluir un objeto attributes en el mismo destinatario. El indicador no sustituye a attributes. Braze usa attributes para crear o actualizar el perfil antes del envío (por ejemplo, para añadir email o campos de teléfono para la entrega por correo electrónico o servicio de mensajes cortos (SMS), o para actualizar grupos de suscripción). Sin ese objeto, no obtendrás el comportamiento combinado previsto para usuarios nuevos en /campaigns/trigger/send o /canvas/trigger/send.
Ese perfil debe seguir cumpliendo las reglas de audiencia y de elegibilidad del canal del mensaje antes de que Braze lo envíe.
Desduplicación de objetos de destinatario
Cuando realizas una llamada a la API con el objeto de destinatario, si existe un destinatario duplicado que tiene como objetivo la misma dirección (es decir, correo electrónico, push), Braze desduplica al usuario, lo que significa que Braze elimina los usuarios idénticos y deja solo uno.
Por ejemplo, si utilizas el mismo external_user_id, el usuario recibirá solo un mensaje. Considera realizar varias llamadas a la API si necesitas una solución alternativa para este comportamiento.
Cuando el mismo external_user_id aparece varias veces en la matriz de destinatarios, Braze envía solo un mensaje y utiliza
las propiedades del desencadenante de la última aparición en la matriz. Este comportamiento es determinista y se basa en el orden de la matriz.
En el siguiente ejemplo, userid1 recibe un mensaje con "name": "Beth Test 2" porque esa entrada aparece en último lugar en la matriz.
{"campaign_id":"#####","recipients":[
{"external_user_id":"userid1","trigger_properties":{"name":"Beth Test 1"}},
{"external_user_id":"userid1","trigger_properties":{"name":"Beth Test 2"}}
]}