Canvas entry properties object

When using one of the endpoints for triggering or scheduling a Canvas through the API, you may provide a map of keys and values to customize messages sent by the first steps of your Canvas, in the canvas_entry_properties namespace.

Object body

This object body contains an example request.

1
"canvas_entry_properties": {"product_name" : "shoes", "product_price" : 79.99}

For example, a request with "canvas_entry_properties": {"product_name" : "shoes", "product_price" : 79.99} could add the word “shoes” to a message by adding {{canvas_entry_properties.${product_name}}} to the request.