Current section
Files
Jump to
Current section
Files
priv/docs/methods/canvases.access.set.json
{
"args": {
"access_level": {
"desc": "Desired level of access _Acceptable values:_ `read` `write` `owner`",
"required": true
},
"canvas_id": {
"desc": "Encoded ID of the canvas",
"example": "F1234ABCD",
"required": true
},
"channel_ids": {
"desc": "List of channels you wish to update access for. Can only be used if user\\_ids is not provided. Both `channel_ids` and `user_ids` cannot be passed at the same time.",
"example": "[\"C1234ABCD\"]",
"required": false,
"type": "array"
},
"user_ids": {
"desc": "List of users you wish to update access for. Can only be used if channel\\_ids is not provided. Both `channel_ids` and `user_ids` cannot be passed at the same time.",
"example": "[\"U1234ABCD\"]",
"required": false,
"type": "array"
}
},
"desc": "Sets the access level to a canvas for specified entities",
"errors": {
"canvas_disabled_user_team": "Canvas is disabled on user's team",
"canvas_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."
},
"rate_limit": {
"label": "Tier 3: 50+ 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"
}
]
}
}