Packages

A Slack Web & Real Time Messaging API client.

Current section

Files

Jump to
slack_kit priv docs methods conversations.canvases.create.json
Raw

priv/docs/methods/conversations.canvases.create.json

{
"args": {
"channel_id": {
"desc": "Channel ID of the channel the canvas will be tabbed in.",
"required": true,
"type": "string"
},
"document_content": {
"desc": "Structure describing the type and value of the content to create",
"example": "{\"type\": \"markdown\", \"markdown\": \"> channel canvas!\"}",
"required": false
},
"title": {
"desc": "Title of the newly created canvas",
"example": "The Coolest Title Ever",
"required": false,
"type": "string"
}
},
"desc": "Create a channel canvas for a channel",
"errors": {
"canvas_creation_failed": "Canvas was unable to be created.",
"canvas_disabled_user_team": "Canvas is disabled on user's team",
"canvas_tab_creation_failed": "Canvas tab was unable to be created.",
"channel_canvas_already_exists": "Channel canvas for the specified channel already exists.",
"channel_canvas_creation_failed": "Channel canvas was unable to be created.",
"free_team_canvas_tab_already_exists": "Canvas tab for specified channel and team tier already exists.",
"restricted_action": "User does not have permission to perform this action.",
"team_tier_cannot_create_channel_canvases": "Team tier cannot create channel canvases"
},
"rate_limit": {
"label": "Tier 2: 20+ per minute",
"url": "https://docs.slack.dev/apis/web-api/rate-limits"
},
"scopes": {
"bot": [
{
"name": "canvases:write",
"url": "https://docs.slack.dev/reference/scopes/canvases.write"
}
],
"user": [
{
"name": "canvases:write",
"url": "https://docs.slack.dev/reference/scopes/canvases.write"
}
]
}
}