Slack.Web.Conversations.Canvases (SlackKit v1.0.0-alpha.0)

View Source

Summary

Functions

Create a channel canvas for a channel

Functions

create(channel_id, optional_params \\ %{})

Create a channel canvas for a channel

API reference

Rate limit: Tier 2: 20+ per minute
Scopes:

View on docs.slack.dev ↗

Required Params

  • channel_id - Channel ID of the channel the canvas will be tabbed in.

Optional Params

  • document_content - Structure describing the type and value of the content to create ex: {"type": "markdown", "markdown": "> channel canvas!"}
  • title - Title of the newly created canvas ex: The Coolest Title Ever

Errors the API can return:

  • 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

See the Common Errors guide for errors returned by every Web API method.