Ruby / Braze Endpoints / Schedule API Triggered Canvases
Back to Collection Items
require 'chilkat'
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
http = Chilkat::CkHttp.new()
# Use this online tool to generate code from sample JSON: Generate Code to Create JSON
# The following JSON is sent in the request body.
# {
# "canvas_id": "canvas_identifier",
# "recipients": [
# {
# "user_alias": "example_alias",
# "external_user_id": "external_user_identifier",
# "trigger_properties": "",
# "canvas_entry_properties": {}
# }
# ],
# "audience": {
# "AND": [
# {
# "custom_attribute": {
# "custom_attribute_name": "eye_color",
# "comparison": "equals",
# "value": "blue"
# }
# },
# {
# "custom_attribute": {
# "custom_attribute_name": "favorite_foods",
# "comparison": "includes_value",
# "value": "pizza"
# }
# },
# {
# "OR": [
# {
# "custom_attribute": {
# "custom_attribute_name": "last_purchase_time",
# "comparison": "less_than_x_days_ago",
# "value": 2
# }
# },
# {
# "push_subscription_status": {
# "comparison": "is",
# "value": "opted_in"
# }
# }
# ]
# },
# {
# "email_subscription_status": {
# "comparison": "is_not",
# "value": "subscribed"
# }
# },
# {
# "last_used_app": {
# "comparison": "after",
# "value": "2019-07-22T13:17:55+0000"
# }
# }
# ]
# },
# "broadcast": false,
# "canvas_entry_properties": {},
# "schedule": {
# "time": "",
# "in_local_time": false,
# "at_optimal_time": false
# }
# }
json = Chilkat::CkJsonObject.new()
json.UpdateString("canvas_id","canvas_identifier")
json.UpdateString("recipients[0].user_alias","example_alias")
json.UpdateString("recipients[0].external_user_id","external_user_identifier")
json.UpdateString("recipients[0].trigger_properties","")
json.UpdateNewObject("recipients[0].canvas_entry_properties")
json.UpdateString("audience.AND[0].custom_attribute.custom_attribute_name","eye_color")
json.UpdateString("audience.AND[0].custom_attribute.comparison","equals")
json.UpdateString("audience.AND[0].custom_attribute.value","blue")
json.UpdateString("audience.AND[1].custom_attribute.custom_attribute_name","favorite_foods")
json.UpdateString("audience.AND[1].custom_attribute.comparison","includes_value")
json.UpdateString("audience.AND[1].custom_attribute.value","pizza")
json.UpdateString("audience.AND[2].OR[0].custom_attribute.custom_attribute_name","last_purchase_time")
json.UpdateString("audience.AND[2].OR[0].custom_attribute.comparison","less_than_x_days_ago")
json.UpdateInt("audience.AND[2].OR[0].custom_attribute.value",2)
json.UpdateString("audience.AND[2].OR[1].push_subscription_status.comparison","is")
json.UpdateString("audience.AND[2].OR[1].push_subscription_status.value","opted_in")
json.UpdateString("audience.AND[3].email_subscription_status.comparison","is_not")
json.UpdateString("audience.AND[3].email_subscription_status.value","subscribed")
json.UpdateString("audience.AND[4].last_used_app.comparison","after")
json.UpdateString("audience.AND[4].last_used_app.value","2019-07-22T13:17:55+0000")
json.UpdateBool("broadcast",false)
json.UpdateNewObject("canvas_entry_properties")
json.UpdateString("schedule.time","")
json.UpdateBool("schedule.in_local_time",false)
json.UpdateBool("schedule.at_optimal_time",false)
http.SetRequestHeader("Content-Type","application/json")
# Adds the "Authorization: Bearer {{api_key}}" header.
http.put_AuthToken("{{api_key}}")
# resp is a CkHttpResponse
resp = http.PostJson3("https://rest.iad-01.braze.com/canvas/trigger/schedule/create","application/json",json)
if (http.get_LastMethodSuccess() == false)
print http.lastErrorText() + "\n";
exit
end
print resp.get_StatusCode().to_s() + "\n";
print resp.bodyStr() + "\n";
Curl Command
curl -X POST
-H "Content-Type: application/json"
-H "Authorization: Bearer {{api_key}}"
-d '{
"canvas_id": "canvas_identifier",
"recipients": [{
"user_alias": "example_alias",
"external_user_id": "external_user_identifier",
"trigger_properties": "",
"canvas_entry_properties": {}
}],
"audience": {
"AND": [
{
"custom_attribute": {
"custom_attribute_name": "eye_color",
"comparison": "equals",
"value": "blue"
}
},
{
"custom_attribute": {
"custom_attribute_name": "favorite_foods",
"comparison": "includes_value",
"value": "pizza"
}
},
{
"OR": [
{
"custom_attribute": {
"custom_attribute_name": "last_purchase_time",
"comparison": "less_than_x_days_ago",
"value": 2
}
},
{
"push_subscription_status": {
"comparison": "is",
"value": "opted_in"
}
}
]
},
{
"email_subscription_status": {
"comparison": "is_not",
"value": "subscribed"
}
},
{
"last_used_app": {
"comparison": "after",
"value": "2019-07-22T13:17:55+0000"
}
}
]
},
"broadcast": false,
"canvas_entry_properties": {},
"schedule": {
"time": "",
"in_local_time": false,
"at_optimal_time": false
}
}'
https://rest.iad-01.braze.com/canvas/trigger/schedule/create
Postman Collection Item JSON
{
"name": "Schedule API Triggered Canvases",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"canvas_id\": \"canvas_identifier\",\n \"recipients\": [{\n \"user_alias\": \"example_alias\",\n \"external_user_id\": \"external_user_identifier\",\n \"trigger_properties\": \"\",\n \"canvas_entry_properties\": {}\n }],\n \"audience\": {\n \"AND\": [\n {\n \"custom_attribute\": {\n \"custom_attribute_name\": \"eye_color\",\n \"comparison\": \"equals\",\n \"value\": \"blue\"\n }\n },\n {\n \"custom_attribute\": {\n \"custom_attribute_name\": \"favorite_foods\",\n \"comparison\": \"includes_value\",\n \"value\": \"pizza\"\n }\n },\n {\n \"OR\": [\n {\n \"custom_attribute\": {\n \"custom_attribute_name\": \"last_purchase_time\",\n \"comparison\": \"less_than_x_days_ago\",\n \"value\": 2\n }\n },\n {\n \"push_subscription_status\": {\n \"comparison\": \"is\",\n \"value\": \"opted_in\"\n }\n }\n ]\n },\n {\n \"email_subscription_status\": {\n \"comparison\": \"is_not\",\n \"value\": \"subscribed\"\n }\n },\n {\n \"last_used_app\": {\n \"comparison\": \"after\",\n \"value\": \"2019-07-22T13:17:55+0000\"\n }\n }\n ]\n },\n \"broadcast\": false,\n \"canvas_entry_properties\": {},\n \"schedule\": {\n \"time\": \"\",\n \"in_local_time\": false,\n \"at_optimal_time\": false\n }\n}\n "
},
"url": {
"raw": "https://{{instance_url}}/canvas/trigger/schedule/create",
"protocol": "https",
"host": [
"{{instance_url}}"
],
"path": [
"canvas",
"trigger",
"schedule",
"create"
],
"query": [
{
"key": "",
"value": "",
"disabled": true
},
{
"key": "",
"value": "",
"disabled": true
},
{
"key": "",
"value": "",
"disabled": true
},
{
"key": "",
"value": "",
"disabled": true
}
]
},
"description": "Use this endpoint to trigger API Triggered Canvases, which are created on the Dashboard and initiated via the API. You can pass in `canvas_entry_properties` that will be templated into the messages sent by the first steps of the Canvas.\n\nThis endpoint allows you to schedule Canvas messages (up to 90 days in advance) via API Triggered delivery, allowing you to decide what action should trigger the message to be sent. Please note that to send messages with this endpoint, you must have a Canvas ID, created when you build a Canvas.\n\n### Request Parameters\n\n| Parameter | Required | Data Type | Description |\n| --------- | ---------| --------- | ----------- |\n|`canvas_id`|Required|String| See canvas identifier|\n|`send_id` | Optional | String | See send identifier |\n|`recipients` | Optional | Array of recipient objects | See recipients object |\n|`audience` | Optional | Connected audience object | See connected audience |\n|`broadcast` | Optional | Boolean | See broadcast -- defaults to false on 8/31/17, must be set to true if \"recipients\" object is omitted |\n| `trigger_properties` | Optional | Object | Personalization key value pairs for all users in this send; see trigger properties |\n| `schedule` | Required | Schedule object | See schedule object |\n\n## Request Components\n- [Canvas Identifier](https://www.braze.com/docs/api/identifier_types/)\n- [Recipients](https://www.braze.com/docs/api/objects_filters/recipient_object/)\n- [Connected Audience](https://www.braze.com/docs/api/objects_filters/connected_audience/)\n- [Broadcast](https://www.braze.com/docs/api/parameters/#broadcast)\n- [Trigger Properties](https://www.braze.com/docs/api/objects_filters/trigger_properties_object/)\n- [Schedule Object](https://www.braze.com/docs/api/objects_filters/schedule_object/)"
},
"response": [
]
}
