Skip to content

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}}}.

Note that while trigger properties can be templated into messages, they aren’t automatically stored in the user profile by default.

Object body

The trigger_properties object supports strings, numbers, booleans, dates, objects, and arrays as data types.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34

{
  "trigger_properties" : {
    "product_name" : "shoes",
    "product_price" : 79.99,
    "details" : {
      "color" : "red",
      "size" : {
        "numerical" : 10,
        "country" : "US"
      }
    },
    "related_skus": ["123", "456", "789"],
    "line_items": [
      {
        "sku": "WH-9000",
        "name": "Wireless Headphones",
        "quantity": 1,
        "pricing": {
          "amount": 79.99,
          "currency": "USD"
        }
      },
      {
        "sku": "RS-450",
        "name": "Running Shoes",
        "quantity": 2,
        "pricing": {
          "amount": 129.99,
          "currency": "USD"
        }
      }
    ]
  }
}

Liquid templating examples

Reference trigger properties in your message templates using the api_trigger_properties namespace:

  • Strings: {{api_trigger_properties.${product_name}}} returns "shoes"
  • Numbers: {{api_trigger_properties.${product_price}}} returns 79.99
  • Nested objects: {{api_trigger_properties.${details}.${color}}} returns "red"
  • Array elements: {{api_trigger_properties.${related_skus}[0]}} returns "123"
  • Complex object arrays: {{api_trigger_properties.${line_items}[0]}} returns the first line item object
New Stuff!