Sets the access level to a canvas for specified entities
POSThttps://slack.com/api/canvases.access.setapplication/x-www-form-urlencodedapplication/jsontokenAuthentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.
xxxx-xxxxxxxxx-xxxxCanvases are only available to Slack workspaces on a paid plan.
The canvases.access.set method sets the access level to a canvas for specified entities. Call the canvases.access.set method to establish and set the desired access level for the canvas.
Share the canvas link in the channel or with the user you are trying to set access levels for, respectively. For instance, if you are passing the user_ids argument to update a specific user's access, you must have sent the user the canvas directly first. Even if the user is a member of a channel where the canvas has been shared, calling the canvases.access.set method with a user_ids argument will fail. Since the permissions are set at the channel level, they must also be changed at the channel level.
Access levels can only be set for regular channels. Channel IDs associated with direct messages (DMs) or multi-party direct messages (MPDMs) will not be accepted and will result in an unsuccessful request. For sharing a canvas to DMs or MPDMs, use individual user IDs instead.
Typical success response
{
"ok": true
}Typical error response when attempting to change the access of a channel canvas
{
"ok": false,
"error": "canvas_not_found"
} 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 |
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 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. |
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 |
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 |
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 |
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 |
invalid_form_data | The method was called via a |
invalid_post_type | The method was called via a |
missing_post_type | The method was called via a |
ratelimited | The request has been ratelimited. Refer to the |
request_timeout | The method was called via a |
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. |
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 |
superfluous_charset | The method was called via a |