Objeto destinatários
O objeto recipients permite que você solicite ou grave informações em nossos endpoints.
É necessário ter external_user_id
, user_alias
ou email
nesse objeto. As solicitações devem especificar apenas uma.
A especificação de um destinatário por endereço de e-mail está atualmente em acesso antecipado. Entre em contato com seu gerente de sucesso do cliente se tiver interesse em participar desse acesso antecipado.
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
[{
"user_alias": (optional, User Alias Object) User alias of user to receive message,
"external_user_id": (optional, string) see External user 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
}]
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"}}
]}