Classic ASP / Braze Endpoints / Canvas Details
Back to Collection Items
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head>
<body>
<%
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.Http")
set http = Server.CreateObject("Chilkat.Http")
' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.JsonObject")
set queryParams = Server.CreateObject("Chilkat.JsonObject")
success = queryParams.UpdateString("canvas_id","{{canvas_identifier}}")
' Adds the "Authorization: Bearer {{api_key}}" header.
http.AuthToken = "{{api_key}}"
' resp is a Chilkat.HttpResponse
Set resp = http.QuickRequestParams("GET","https://rest.iad-01.braze.com/canvas/details",queryParams)
If (http.LastMethodSuccess = 0) Then
Response.Write "<pre>" & Server.HTMLEncode( http.LastErrorText) & "</pre>"
Response.End
End If
Response.Write "<pre>" & Server.HTMLEncode( resp.StatusCode) & "</pre>"
Response.Write "<pre>" & Server.HTMLEncode( resp.BodyStr) & "</pre>"
%>
</body>
</html>
Curl Command
curl -G -d "canvas_id=%7B%7Bcanvas_identifier%7D%7D"
-H "Authorization: Bearer {{api_key}}"
https://rest.iad-01.braze.com/canvas/details
Postman Collection Item JSON
{
"name": "Canvas Details",
"request": {
"method": "GET",
"header": [
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"type": "text"
}
],
"url": {
"raw": "https://{{instance_url}}/canvas/details?canvas_id={{canvas_identifier}}",
"protocol": "https",
"host": [
"{{instance_url}}"
],
"path": [
"canvas",
"details"
],
"query": [
{
"key": "canvas_id",
"value": "{{canvas_identifier}}",
"description": "(Required) String\n\nCanvas API Identifier "
}
]
},
"description": "This endpoint allows you to export metadata about a Canvas, such as its name, when it was created, its current status, and more.\n\n### Components Used\n- [Canvas Identifier](https://www.braze.com/docs/api/identifier_types/)\n\n## Response\n\n```json\nContent-Type: application/json\nAuthorization: Bearer YOUR-REST-API-KEY\n{\n \"created_at\": (string) date created as ISO 8601 date,\n \"updated_at\": (string) date updated as ISO 8601 date,\n \"name\": (string) Canvas name,\n \"description\": (string) Canvas description,\n \"archived\": (boolean) whether this Canvas is archived,\n \"draft\": (boolean) whether this Canvas is a draft,\n \"schedule_type\": (string) type of scheduling action,\n \"first_entry\": (string) date of first entry as ISO 8601 date,\n \"last_entry\": (string) date of last entry as ISO 8601 date,\n \"channels\": (array of strings) step channels used with Canvas,\n \"variants\": [\n {\n \"name\": (string) name of variant,\n \"id\": (string) API identifier of the variant,\n \"first_step_ids\": (array of strings) API identifiers for first steps in variant,\n \"first_step_id\": (string) API identifier of first step in variant (deprecated in November 2017, only included if the variant has only one first step)\n },\n ... (more variations)\n ],\n \"tags\": (array of strings) tag names associated with the Canvas,\n \"steps\": [\n {\n \"name\": (string) name of step,\n \"id\": (string) API identifier of the step,\n \"next_step_ids\": (array of strings) API identifiers of steps following step,\n \"channels\": (array of strings) channels used in step,\n \"messages\": {\n \"message_variation_id\": (string) { // <=This is the actual id\n \"channel\": (string) channel type of the message (eg., \"email\"),\n ... channel-specific fields for this message, see Campaign Details Endpoint API Response for example message responses ...\n }\n }\n },\n ... (more steps)\n ],\n \"message\": (required, string) the status of the export, returns 'success' when completed without errors\n}\n```"
},
"response": [
]
}
