Skip to main content

canvases.create method

Usage info​

This method is used to create a new standalone canvas owned by the acting user.

The canvas will be created untitled and empty if none of the optional parameters are specified.

The canvas may be created with a title. The canvas may also be created with some initial document_content. The canvas's ID is returned in the response from the create call.

A canvas can be automatically added to a channel tab with write permissions by setting the channel_id parameter.

You can update the canvas's channel or user access by calling the canvases.access.set method.

The following formatting elements are supported in the document_content object:

  • bold
  • bulleted lists
  • checklist
  • canvas unfurl
  • code block
  • code span
  • divider (horizontal rule)
  • emojis—standard and custom
  • file unfurls
  • hard line break
  • headings h1-h3
  • italic
  • link (in line)
  • link reference
  • markdown table
  • message unfurl
  • ordered lists
  • paragraph
  • profile unfurl
  • quote block
  • strikethrough
  • website unfurl
  • @ mentions for users and channels

Find more details about formatting the document_content object in the Canvas surface documentation.

Response​