Objeto destinatários

O objeto recipients permite que você solicite ou grave informações em nossos endpoints.

É necessário que external_user_id, user_alias, braze_id ou email estejam presentes neste objeto. As solicitações devem especificar apenas uma.

O objeto destinatários permite combinar o objeto de alias de usuário, o objeto de propriedades do disparador e o objeto de propriedades de entrada do Canva.

Corpo do objeto

1
2
3
4
5
6
7
8
9
[{
  "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,
  "canvas_entry_properties": (optional, object) personalization key-value pairs for this user when triggering a Canvas; see Canvas Entry Properties
}]

Quando send_to_existing_only for true, a Braze enviará a mensagem apenas para os usuários existentes. No entanto, esse sinalizador não pode ser usado com aliases de usuário. Quando send_to_existing_only é false, uma atribuição precisa ser incluída. A Braze criará um usuário com o endereço id e as atribuições antes de enviar a mensagem.

• ID da Braze
• Alias do usuário
• ID de usuário externo
• Priorização

Eliminação de objetos do destinatário

Ao fazer uma chamada de API com o objeto recipient, se houver um recipient duplicado direcionando para o mesmo endereço (ou seja, e-mail, push), o usuário será desduplicado, o que significa que usuários idênticos serão removidos, restando um.

Por exemplo, se o mesmo external_user_id for usado, apenas uma mensagem será recebida. Considere fazer várias chamadas à API se precisar de uma solução alternativa para esse comportamento.

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