Schedule API Triggered Canvases

v1.0.0

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.

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

Request Parameters

Parameter	Required	Data Type	Description
`canvas_id`	Required	String	See canvas identifier
`send_id`	Optional	String	See send identifier
`recipients`	Optional	Array of recipient objects	See recipients object
`audience`	Optional	Connected audience object	See connected audience
`broadcast`	Optional	Boolean	See broadcast -- defaults to false on 8/31/17, must be set to true if "recipients" object is omitted
`trigger_properties`	Optional	Object	Personalization key value pairs for all users in this send; see trigger properties
`schedule`	Required	Schedule object	See schedule object

Request Components

Input

{
  "type": "object",
  "properties": {
    "audience": {
      "type": "object",
      "properties": {
        "AND": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "custom_attribute": {
                "type": "object",
                "properties": {
                  "comparison": {
                    "type": "string"
                  },
                  "custom_attribute_name": {
                    "type": "string"
                  },
                  "value": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "broadcast": {
      "type": "boolean"
    },
    "canvas_entry_properties": {
      "type": "object",
      "properties": {}
    },
    "canvas_id": {
      "type": "string"
    },
    "recipients": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "canvas_entry_properties": {
            "type": "object",
            "properties": {}
          },
          "external_user_id": {
            "type": "string"
          },
          "trigger_properties": {
            "type": "string"
          },
          "user_alias": {
            "type": "string"
          }
        }
      }
    },
    "schedule": {
      "type": "object",
      "properties": {
        "at_optimal_time": {
          "type": "boolean"
        },
        "in_local_time": {
          "type": "boolean"
        },
        "time": {
          "type": "string"
        }
      }
    }
  }
}

Output

{
  "type": "object",
  "additionalProperties": true
}