Recipient Object

The Recipient Object allows you to request or write information in our endpoints.

Either external_user_id or user_alias is required in this object. Requests must specify only one.

The Recipient object allows you to combine the User Alias object, the Trigger Properties object, and the Canvas Entry Properties object.

Object Body

1
2
3
4
5
6
{
  "user_alias": (optional, User Alias Object) User Alias of user to receive message,
  "external_user_id": (optional, string) see External User Id,
  "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
}

Recipient Object Deduping

When making an API call with the Recipient Object, if there exists a duplicated recipient targeting the same address (ie email, push), the user will be deduped, meaning identical users will be removed, leaving one.

For example, if the same external_user_id is used, then only 1 message will be received. Consider making multiple API calls if you need a work-around for this behavior.

1
2
3
4
{"api_key":"#####","campaign_id":"#####","recipients":[
{"external_user_id":"userid1","trigger_properties":{"name":"Beth Test 1"}},
{"external_user_id":"userid1","trigger_properties":{"name":"Beth Test 2"}} 
]}
WAS THIS PAGE HELPFUL?
New Stuff!