Trigger properties object

When using one of the endpoints for sending a campaign with API-triggered delivery, you may provide a map of keys and values to customize your message.

If you make an API request that contains an object in trigger_properties, the values in that object can then be referenced in your message template under the api_trigger_properties namespace. For example, a request with the following could add the word "shoes" to a message by adding {{api_trigger_properties.${product_name}}}.

Object body

1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
  "trigger_properties" : {
    "product_name" : "shoes",
    "product_price" : 79.99,
    "details" : {
      "color" : "red",
      "size" : {
        "numerical" : 10,
        "country" : "US"
      }
    },
    "related_skus": ["123", "456", "789"]
  }
}