Attachment Input: Canvas App

Canvas app attachment input.

This request body isn’t available in version 32.0 and later. In version 32.0 and later, use Canvas Capability Input.

Important

XML

In XML request bodies, attachmentType is an attribute of the <attachment> element.

1<attachment attachmentType="Canvas">
2   <developerName>TravelApp</developerName>
3</attachment>

JSON

1{"attachment" :
2  {
3    "attachmentType" : "Canvas",
4    "developerName" : "TravelApp",
5    "namespacePrefix" : "dev_org",
6    "parameters" : "{&quot;itinerary&quot;:&quot;123&quot;}",
7    "height" : "250px",
8    "title" : "TravelItinerary",
9  }
10}

Properties

Name	Type	Description	Available Version
`attachmentType`	String	The attachment type. Must contain the value `Canvas`.	29.0–31.0
`description`	String	Optional. The description of the canvas app.	29.0–31.0
`developerName`	String	The developer name (API name) of the canvas app	29.0–31.0
`height`	String	Optional. The height of the canvas app in pixels. Default height is 200 pixels.	29.0–31.0
`namespacePrefix`	String	Optional. The namespace prefix of the Developer Edition organization in which the canvas app was created.	29.0–31.0
`parameters`	String	Optional. Parameters passed to the canvas app in JSON format. The JSON must be escaped.	29.0–31.0
`thumbnailUrl`	String	Optional. The URL to a thumbnail image for the canvas app. Maximum dimensions are 120x120 pixels.	29.0–31.0
`title`	String	Optional. The title of the link used to call the canvas app.	29.0–31.0

Connect REST API Developer Guide

Attachment Input: Canvas App