conversations.canvases.create

View other methods

Create a channel canvas for a channel

Reference docs Tester

Facts

Method access

HTTP

JavaScript

Python

Java

HTTP

POSThttps://slack.com/api/conversations.canvases.create

Bolt for Java

app.client().conversationsCanvasesCreate

Bolt for Python

app.client.conversations_canvases_create

Bolt for JavaScript

app.client.conversations.canvases.create

Required scopes

Bot tokenscanvases:write

User tokenscanvases:write

Content types

application/x-www-form-urlencodedapplication/json

Rate limits

Tier 2

Arguments

Required arguments

token

token

·Required

Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.

Example

xxxx-xxxxxxxxx-xxxx

channel_id

string

·Required

Channel ID of the channel we create the channel canvas for

Example

C1234567890

Optional arguments

document_content

·Optional

Structure describing the type and value of the content to create

Example

{"type": "markdown", "markdown": "> channel canvas!"}

Usage info

This method is used to create a new channel canvas for the channel. Channel canvases can act as a resource hub, providing users with information highlights and channel-specific details. Once a channel canvas has been created with document_content, you will see the canvas icon in the upper right of the channel switch to indicate that a channel canvas now exists. This method returns an ok: true response with the canvas ID.

A canvas will be created empty if no content is provided, but will not result in an icon change.

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
message unfurl
ordered lists
paragraph
profile unfurl
quote block
strikethrough
website unfurl
@ mentions for users and channels

Calling conversations.canvases.create when a channel canvas already exists will result in a channel_canvas_already_exists response. You can find the ID of the canvas in the channel.properties.canvas section in the response of a conversations.info request.

In order for your app to create a channel canvas, it must have the proper permissions to do so. The channel must be public, or if it is private the app/user must be invited to the channel. Unlike the need to share a standalone canvas, there are no access implications nor is it necessary to share a channel canavs to grant access. Access is tied to channel access.

If you are looking to create a standalone canvas not associated with a particular channel, use the canvases.create method instead.

Example responses

Common successful response

Typical success response

{
    "ok": true,
    "canvas_id": "F1234ABCD"
}

Common error response

Typical error response when the channel canvas has already been created for the channel

{
    "ok": false,
    "error": "channel_canvas_already_exists"
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing. Callers should always check the value of the ok params in the response.

Error	Description
`canvas_disabled_user_team`	Canvas is disabled on user's team
`restricted_action`	User does not have permission to perform this action.
`channel_canvas_creation_failed`	Channel canvas was unable to be created.
`channel_canvas_already_exists`	Channel canvas for the specified channel already exists.
`team_tier_cannot_create_channel_canvases`	Team tier cannot create channel canvases
`canvas_creation_failed`	Canvas was unable to be created.
`canvas_tab_creation_failed`	Canvas tab was unable to be created.
`free_team_canvas_tab_already_exists`	Canvas tab for specified channel and team tier already exists.
`access_denied`	Access to a resource specified in the request is denied.
`account_inactive`	Authentication token is for a deleted user or workspace when using a `bot` token.
`deprecated_endpoint`	The endpoint has been deprecated.
`ekm_access_denied`	Administrators have suspended the ability to post a message.
`enterprise_is_restricted`	The method cannot be called from an Enterprise.
`invalid_auth`	Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.
`is_bot`	This method cannot be called by a legacy bot.
`method_deprecated`	The method has been deprecated.
`missing_scope`	The token used is not granted the specific scope permissions required to complete this request.
`not_allowed_token_type`	The token type used in this request is not allowed.
`not_authed`	No authentication token provided.
`no_permission`	The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.
`org_login_required`	The workspace is undergoing an enterprise migration and will not be available until migration is complete.
`token_expired`	Authentication token has expired
`token_revoked`	Authentication token is for a deleted user or workspace or the app has been removed when using a `user` token.
`two_factor_setup_required`	Two factor setup is required.
`team_access_not_granted`	The token used is not granted the specific workspace access required to complete this request.
`accesslimited`	Access to this method is limited on the current network
`fatal_error`	The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.
`internal_error`	The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.
`invalid_arg_name`	The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than `_`. If you get this error, it is typically an indication that you have made a very malformed API call.
`invalid_arguments`	The method was either called with invalid arguments or some detail about the arguments passed is invalid, which is more likely when using complex arguments like blocks or attachments.
`invalid_array_arg`	The method was passed an array as an argument. Please only input valid strings.
`invalid_charset`	The method was called via a `POST` request, but the `charset` specified in the `Content-Type` header was invalid. Valid charset names are: `utf-8` `iso-8859-1`.
`invalid_form_data`	The method was called via a `POST` request with `Content-Type` `application/x-www-form-urlencoded` or `multipart/form-data`, but the form data was either missing or syntactically invalid.
`invalid_post_type`	The method was called via a `POST` request, but the specified `Content-Type` was invalid. Valid types are: `application/json` `application/x-www-form-urlencoded` `multipart/form-data` `text/plain`.
`missing_post_type`	The method was called via a `POST` request and included a data payload, but the request did not include a `Content-Type` header.
`ratelimited`	The request has been ratelimited. Refer to the `Retry-After` header for when to retry the request.
`request_timeout`	The method was called via a `POST` request, but the `POST` data was either missing or truncated.
`service_unavailable`	The service is temporarily unavailable
`team_added_to_org`	The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.

Warnings

This table lists the expected warnings that this method will return. However, other warnings can be returned in the case where the service is experiencing unexpected trouble.

Warning	Description
`missing_charset`	The method was called via a `POST` request, and recommended practice for the specified `Content-Type` is to include a `charset` parameter. However, no `charset` was present. Specifically, non-form-data content types (e.g. `text/plain`) are the ones for which `charset` is recommended.
`superfluous_charset`	The method was called via a `POST` request, and the specified `Content-Type` is not defined to understand the `charset` parameter. However, `charset` was in fact present. Specifically, form-data content types (e.g. `multipart/form-data`) are the ones for which `charset` is superfluous.

API response

URL

POST body

Submit your arguments to see the API response