Slack. Web. Canvases. Access
(SlackKit v1.0.0-alpha.0)
View Source
Summary
Functions
Remove access to a canvas for specified entities
Sets the access level to a canvas for specified entities
Functions
Remove access to a canvas for specified entities
API reference
Rate limit: Tier 3: 50+ per minute
Scopes:
- Bot token:
canvases:write - User token:
canvases:write
Required Params
canvas_id- Encoded ID of the canvas ex:F1234ABCD
Optional Params
channel_ids- List of channels you wish to update access for ex:["C1234ABCD"]user_ids- List of users you wish to update access for ex:["U1234ABCD"]
Errors the API can return:
canvas_disabled_user_team- Canvas is disabled on user's team.canvas_not_found- The canvas you wish to revoke permissions for is not available.channel_not_found- A channel could not be found.invalid_parameters- One of user_ids and channel_ids must be defined.restricted_action- User does not have permission to perform this action.user_not_found- A user could not be found.
See the Common Errors guide for errors returned by every Web API method.
Sets the access level to a canvas for specified entities
API reference
Rate limit: Tier 3: 50+ per minute
Scopes:
- Bot token:
canvases:write - User token:
canvases:write
Required Params
access_level- Desired level of access Acceptable values:readwriteownercanvas_id- Encoded ID of the canvas ex:F1234ABCD
Optional Params
channel_ids- List of channels you wish to update access for. Can only be used if user_ids is not provided. Bothchannel_idsanduser_idscannot be passed at the same time. ex:["C1234ABCD"]user_ids- List of users you wish to update access for. Can only be used if channel_ids is not provided. Bothchannel_idsanduser_idscannot be passed at the same time. ex:["U1234ABCD"]
Errors the API can return:
canvas_disabled_user_team- Canvas is disabled on user's teamcanvas_not_found- The canvas you wish to update permissions for is not available.channel_not_found- A channel could not be found.failed_to_update_user_ids- Failed to update the specified user_ids.invalid_parameters- One of user_ids or channel_ids must be defined, but not both.restricted_action- User does not have permission to perform this action.user_not_found- A user could not be found.
See the Common Errors guide for errors returned by every Web API method.