Objeto destinatários
O objeto de destinatários permite que você solicite ou grave informações em nossos endpoints.
Você deve incluir um dos seguintes neste objeto: external_user_id, user_alias, braze_id ou email. As solicitações devem especificar apenas um.
O objeto de destinatários permite combinar o objeto de alias do usuário, o objeto de propriedades do disparo, o objeto de propriedades de entrada do Canvas e o objeto de atributos do usuário.
Corpo do 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
}]
Quando send_to_existing_only é true, a Braze envia a mensagem apenas para usuários existentes. No entanto, você não pode usar essa flag com aliases de usuário.
Quando send_to_existing_only é false, você precisa incluir um objeto attributes no mesmo destinatário. A flag não substitui attributes. A Braze usa attributes para criar ou atualizar o perfil antes do envio (por exemplo, adicionar email ou campos de telefone para entrega por e-mail ou SMS, ou atualizar grupos de inscrições). Sem esse objeto, você não obtém o comportamento combinado esperado para usuários novos em /campaigns/trigger/send ou /canvas/trigger/send.
Esse perfil ainda precisa atender às regras de público e de elegibilidade de canal da mensagem antes que a Braze faça o envio.
Deduplicação do objeto de destinatários
Ao fazer uma chamada de API com o objeto de destinatários, se houver um destinatário duplicado direcionado ao mesmo endereço (ou seja, e-mail, push), a Braze faz a deduplicação do usuário. Isso significa que a Braze remove os usuários idênticos e mantém apenas um.
Por exemplo, se você usar o mesmo external_user_id, o usuário receberá apenas uma mensagem. Se precisar contornar esse comportamento, considere fazer várias chamadas de API.
Quando o mesmo external_user_id aparece várias vezes no array de destinatários, a Braze envia apenas uma mensagem e usa as propriedades de disparo da última ocorrência no array. Esse comportamento é determinístico e se baseia na ordem do array.
No exemplo a seguir, userid1 recebe uma mensagem usando "name": "Beth Test 2", porque essa entrada aparece por último no array.
{"campaign_id":"#####","recipients":[
{"external_user_id":"userid1","trigger_properties":{"name":"Beth Test 1"}},
{"external_user_id":"userid1","trigger_properties":{"name":"Beth Test 2"}}
]}