Slack.Web.Admin.Teams.Settings (SlackKit v0.25.0-alpha.0)

token_revoked - Authentication token is for a deleted user or workspace or the app has been removed when using a user token.
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 _. If you get this error, it is typically an indication that you have made a very malformed API call.
two_factor_setup_required - Two factor setup is required.
feature_not_enabled - The Admin APIs feature is not enabled for this team.
invalid_form_data - The method was called via a POST request with Content-Type application/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.
invalid_post_type - The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/json application/x-www-form-urlencoded multipart/form-data text/plain.
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.
deprecated_endpoint - The endpoint has been deprecated.
ratelimited - The request has been ratelimited. Refer to the Retry-After header for when to retry the request.
ekm_access_denied - Administrators have suspended the ability to post a message.
service_unavailable - The service is temporarily unavailable
team_access_not_granted - The token used is not granted the specific workspace access required to complete this request.
invalid_arguments - The method was called with invalid arguments.
invalid_array_arg - The method was passed an array as an argument. Please only input valid strings.
request_timeout - The method was called via a POST request, but the POST data was either missing or truncated.
team_not_found - The team_id was not found.
account_inactive - Authentication token is for a deleted user or workspace when using a bot token.
not_authed - No authentication token provided.
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.
enterprise_is_restricted - The method cannot be called from an Enterprise.
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.
access_denied - Access to a resource specified in the request is denied.
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.
failed_to_fetch_info - There was an error fetching info for this workspace.
missing_scope - The token used is not granted the specific scope permissions required to complete this request.
missing_post_type - The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.
accesslimited - Access to this method is limited on the current network
token_expired - Authentication token has expired
invalid_charset - The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8 iso-8859-1.
method_deprecated - The method has been deprecated.
not_allowed_token_type - The token type used in this request is not allowed.
org_login_required - The workspace is undergoing an enterprise migration and will not be available until migration is complete.
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.

set_default_channels(channel_ids, team_id, optional_params \\ %{})

Set the default channels of a workspace.

Required Params

channel_ids - An array of channel IDs.
team_id - ID for the workspace to set the default channel for.

Errors the API can return:

token_revoked - Authentication token is for a deleted user or workspace or the app has been removed when using a user token.
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 _. If you get this error, it is typically an indication that you have made a very malformed API call.
two_factor_setup_required - Two factor setup is required.
feature_not_enabled - The Admin APIs feature is not enabled for this team.
invalid_form_data - The method was called via a POST request with Content-Type application/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.
invalid_post_type - The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/json application/x-www-form-urlencoded multipart/form-data text/plain.
restricted_action - The actor does not have admin permissions for the team in context
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.
deprecated_endpoint - The endpoint has been deprecated.
ratelimited - The request has been ratelimited. Refer to the Retry-After header for when to retry the request.
ekm_access_denied - Administrators have suspended the ability to post a message.
service_unavailable - The service is temporarily unavailable
team_access_not_granted - The token used is not granted the specific workspace access required to complete this request.
invalid_arguments - The method was called with invalid arguments.
one_or_more_invalid_channels - One or more of the passed channel IDs was invalid.
invalid_array_arg - The method was passed an array as an argument. Please only input valid strings.
request_timeout - The method was called via a POST request, but the POST data was either missing or truncated.
team_not_found - team_id was not found.
account_inactive - Authentication token is for a deleted user or workspace when using a bot token.
failed_to_set_default_channels - We encountered an error while trying to set the default channel.
not_authed - No authentication token provided.
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.
enterprise_is_restricted - The method cannot be called from an Enterprise.
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.
access_denied - Access to a resource specified in the request is denied.
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.
missing_scope - The token used is not granted the specific scope permissions required to complete this request.
missing_post_type - The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.
accesslimited - Access to this method is limited on the current network
not_an_admin - This method is only accessible by org owners and admins.
token_expired - Authentication token has expired
invalid_charset - The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8 iso-8859-1.
method_deprecated - The method has been deprecated.
not_allowed_token_type - The token type used in this request is not allowed.
org_login_required - The workspace is undergoing an enterprise migration and will not be available until migration is complete.
invalid_auth - The given token is not authorized for the requested team_id.

set_description(description, team_id, optional_params \\ %{})

Set the description of a given workspace.

Required Params

description - The new description for the workspace.
team_id - ID for the workspace to set the description for.

Errors the API can return:

token_revoked - Authentication token is for a deleted user or workspace or the app has been removed when using a user token.
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 _. If you get this error, it is typically an indication that you have made a very malformed API call.
two_factor_setup_required - Two factor setup is required.
feature_not_enabled - The Admin APIs feature is not enabled for this team.
invalid_form_data - The method was called via a POST request with Content-Type application/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.
invalid_post_type - The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/json application/x-www-form-urlencoded multipart/form-data text/plain.
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.
deprecated_endpoint - The endpoint has been deprecated.
ratelimited - The request has been ratelimited. Refer to the Retry-After header for when to retry the request.
ekm_access_denied - Administrators have suspended the ability to post a message.
service_unavailable - The service is temporarily unavailable
team_access_not_granted - The token used is not granted the specific workspace access required to complete this request.
invalid_arguments - The method was called with invalid arguments.
failed_to_set_description - There was an error setting the description.
invalid_array_arg - The method was passed an array as an argument. Please only input valid strings.
request_timeout - The method was called via a POST request, but the POST data was either missing or truncated.
team_not_found - The requested team_id can't be found.
account_inactive - Authentication token is for a deleted user or workspace when using a bot token.
not_authed - No authentication token provided.
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.
enterprise_is_restricted - The method cannot be called from an Enterprise.
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.
access_denied - Access to a resource specified in the request is denied.
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.
missing_scope - The token used is not granted the specific scope permissions required to complete this request.
missing_post_type - The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.
accesslimited - Access to this method is limited on the current network
token_expired - Authentication token has expired
invalid_charset - The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8 iso-8859-1.
method_deprecated - The method has been deprecated.
not_allowed_token_type - The token type used in this request is not allowed.
org_login_required - The workspace is undergoing an enterprise migration and will not be available until migration is complete.
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.

set_discoverability(discoverability, team_id, optional_params \\ %{})

An API method that allows admins to set the discoverability of a given workspace

Required Params

discoverability - This workspace's discovery setting. It must be set to one of open, invite_only, closed, or unlisted.
team_id - The ID of the workspace to set discoverability on.

Errors the API can return:

token_revoked - Authentication token is for a deleted user or workspace or the app has been removed when using a user token.
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 _. If you get this error, it is typically an indication that you have made a very malformed API call.
two_factor_setup_required - Two factor setup is required.
feature_not_enabled - The Admin APIs feature is not enabled for this team.
invalid_form_data - The method was called via a POST request with Content-Type application/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.
invalid_post_type - The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/json application/x-www-form-urlencoded multipart/form-data text/plain.
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.
deprecated_endpoint - The endpoint has been deprecated.
ratelimited - The request has been ratelimited. Refer to the Retry-After header for when to retry the request.
ekm_access_denied - Administrators have suspended the ability to post a message.
service_unavailable - The service is temporarily unavailable
failed_to_set_discoverability - There was an error setting the discoverability of this workspace.
team_access_not_granted - The token used is not granted the specific workspace access required to complete this request.
invalid_arguments - The method was called with invalid arguments.
invalid_array_arg - The method was passed an array as an argument. Please only input valid strings.
request_timeout - The method was called via a POST request, but the POST data was either missing or truncated.
team_not_found - The team_id was not found.
account_inactive - Authentication token is for a deleted user or workspace when using a bot token.
not_authed - No authentication token provided.
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.
enterprise_is_restricted - The method cannot be called from an Enterprise.
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.
access_denied - Access to a resource specified in the request is denied.
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.
missing_scope - The token used is not granted the specific scope permissions required to complete this request.
missing_post_type - The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.
accesslimited - Access to this method is limited on the current network
token_expired - Authentication token has expired
discoverability_setting_invalid - The discovery setting must be set to one of open, invite_only, closed, or unlisted.
invalid_charset - The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8 iso-8859-1.
method_deprecated - The method has been deprecated.
not_allowed_token_type - The token type used in this request is not allowed.
org_login_required - The workspace is undergoing an enterprise migration and will not be available until migration is complete.
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.

set_icon(image_url, team_id, optional_params \\ %{})

Sets the icon of a workspace.

Required Params

image_url - Image URL for the icon ex: http://mysite.com/icon.jpeg
team_id - ID for the workspace to set the icon for.

Errors the API can return:

failed_to_set_icon - Setting the url in the database failed. This may be transient, please try again soon.
token_revoked - Authentication token is for a deleted user or workspace or the app has been removed when using a user token.
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 _. If you get this error, it is typically an indication that you have made a very malformed API call.
two_factor_setup_required - Two factor setup is required.
feature_not_enabled - The Admin APIs feature is not enabled for this team.
invalid_form_data - The method was called via a POST request with Content-Type application/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.
invalid_post_type - The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/json application/x-www-form-urlencoded multipart/form-data text/plain.
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.
deprecated_endpoint - The endpoint has been deprecated.
invalid_url - Invalid url.
ratelimited - The request has been ratelimited. Refer to the Retry-After header for when to retry the request.
ekm_access_denied - Administrators have suspended the ability to post a message.
service_unavailable - The service is temporarily unavailable
team_access_not_granted - The token used is not granted the specific workspace access required to complete this request.
invalid_arguments - The method was called with invalid arguments.
invalid_array_arg - The method was passed an array as an argument. Please only input valid strings.
request_timeout - The method was called via a POST request, but the POST data was either missing or truncated.
team_not_found - team_id was not found.
account_inactive - Authentication token is for a deleted user or workspace when using a bot token.
not_authed - No authentication token provided.
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.
enterprise_is_restricted - The method cannot be called from an Enterprise.
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.
access_denied - Access to a resource specified in the request is denied.
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.
missing_scope - The token used is not granted the specific scope permissions required to complete this request.
missing_post_type - The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.
accesslimited - Access to this method is limited on the current network
not_an_admin - This method is only accessible by org owners and admins.
token_expired - Authentication token has expired
invalid_charset - The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8 iso-8859-1.
method_deprecated - The method has been deprecated.
not_allowed_token_type - The token type used in this request is not allowed.
org_login_required - The workspace is undergoing an enterprise migration and will not be available until migration is complete.
invalid_auth - The given token is not authorized for the requested team_id.

set_name(name, team_id, optional_params \\ %{})

Set the name of a given workspace.

Required Params

name - The new name of the workspace.
team_id - ID for the workspace to set the name for.

Errors the API can return:

failed_to_set_name - Returned when there is an error to set the name
token_revoked - Authentication token is for a deleted user or workspace or the app has been removed when using a user token.
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 _. If you get this error, it is typically an indication that you have made a very malformed API call.
two_factor_setup_required - Two factor setup is required.
feature_not_enabled - The Admin APIs feature is not enabled for this team.
invalid_form_data - The method was called via a POST request with Content-Type application/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.
invalid_post_type - The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/json application/x-www-form-urlencoded multipart/form-data text/plain.
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.
deprecated_endpoint - The endpoint has been deprecated.
ratelimited - The request has been ratelimited. Refer to the Retry-After header for when to retry the request.
ekm_access_denied - Administrators have suspended the ability to post a message.
service_unavailable - The service is temporarily unavailable
team_access_not_granted - The token used is not granted the specific workspace access required to complete this request.
invalid_arguments - The method was called with invalid arguments.
invalid_array_arg - The method was passed an array as an argument. Please only input valid strings.
request_timeout - The method was called via a POST request, but the POST data was either missing or truncated.
team_not_found - Returned when team_id can’t be resolved
account_inactive - Authentication token is for a deleted user or workspace when using a bot token.
not_authed - No authentication token provided.
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.
enterprise_is_restricted - The method cannot be called from an Enterprise.
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.
access_denied - Access to a resource specified in the request is denied.
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.
missing_scope - The token used is not granted the specific scope permissions required to complete this request.
missing_post_type - The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.
accesslimited - Access to this method is limited on the current network
token_expired - Authentication token has expired
invalid_charset - The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8 iso-8859-1.
method_deprecated - The method has been deprecated.
not_allowed_token_type - The token type used in this request is not allowed.
org_login_required - The workspace is undergoing an enterprise migration and will not be available until migration is complete.
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.