Approve an app for installation on a workspace.

Optional Params

• app_id - The id of the app to approve. Either app_id or request_id is required. ex: A12345
• bot_scopes - Bot scopes to approve for the app. You can approve a set of scopes by providing user_scopes or bot_scopes. ex: emoji:read,pins:read
• enterprise_id - The ID of the enterprise to approve the app on. Exactly one of the team_id or enterprise_id arguments is required, not both. ex: E12345
• request_id - The id of the request to approve. Either app_id or request_id is required. ex: Ar12345
• team_id - The ID of the workspace to approve the app on. Exactly one of the team_id or enterprise_id arguments is required, not both. ex: T12345
• user_scopes - User scopes to approve for the app. You can approve a set of scopes by providing user_scopes or bot_scopes. ex: emoji:read,pins:read

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 - Returned when 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.
• too_many_ids_provided - Please provide only app_id OR request_id
• 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.
• too_many_teams_provided - Please provide only team_id OR enterprise_id
• 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
• invalid_scopes - Some of the provided scopes do not exist
• team_access_not_granted - The token used is not granted the specific workspace access required to complete this request.
• app_management_app_not_installed_on_org - The app management app must be installed on the org.
• invalid_arguments - The method was called with invalid arguments.
• app_restricted_org_wide - The app is already restricted org wide.
• 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 is 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
• request_id_or_app_id_is_required - Must include a request_id or app_id
• request_already_resolved - The app request has already been resolved
• 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.
• invalid_app_id - The app_id passed is invalid.
• invalid_request_id - The request_id passed is invalid.
• org_resolution_required - The team_id is in an Enterprise org while app_id is certified.
• 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.
• custom_integration_not_allowed_at_enterprise - Returned when the install request is for custom integration app.
• request_id_required_for_custom_integrations - A request_id is required for custom integrations

Clear an app resolution

Required Params

• app_id - The id of the app whose resolution you want to clear/undo. ex: A12345

Optional Params

• enterprise_id - The enterprise to clear the app resolution from. Exactly one of the team_id or enterprise_id arguments is required, not both. ex: E12345
• team_id - The workspace to clear the app resolution from. Exactly one of the team_id or enterprise_id arguments is required, not both. ex: T12345

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 - Returned when 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 - This actor does not have access to the permissions on this resource.
• 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.
• too_many_teams_provided - Please provide only team_id OR enterprise_id
• 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.
• app_management_app_not_installed_on_org - The app management app must be installed on the org.
• no_resolution_found - No existing resolutions were found for the given team and app_id.
• 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 is 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 - This actor does not have access to the permissions on this resource.
• 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.
• invalid_app_id - The app_id passed is invalid.
• 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.

Restrict an app for installation on a workspace.

Optional Params

• app_id - The id of the app to restrict. Either app_id or request_id is required. ex: A12345
• enterprise_id - The ID of the enterprise to approve the app on. Exactly one of the team_id or enterprise_id arguments is required, not both. ex: E12345
• request_id - The id of the request to restrict. Either app_id or request_id is required. ex: Ar12345
• team_id - The ID of the workspace to approve the app on. Exactly one of the team_id or enterprise_id arguments is required, not both. ex: T12345

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 - Returned when 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.
• too_many_ids_provided - Please provide only app_id OR request_id
• 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.
• too_many_teams_provided - Please provide only team_id OR enterprise_id
• 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
• invalid_scopes - Some of the provided scopes do not exist
• team_access_not_granted - The token used is not granted the specific workspace access required to complete this request.
• app_management_app_not_installed_on_org - The app management app must be installed on the org.
• 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 is 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
• request_id_or_app_id_is_required - Must include a request_id or app_id
• request_already_resolved - The app request has already been resolved
• 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.
• invalid_app_id - The app_id passed is invalid.
• invalid_request_id - The request_id passed is invalid.
• 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.
• custom_integration_not_allowed_at_enterprise - Returned when the install request is for custom integration app.
• request_id_required_for_custom_integrations - A request_id is required for custom integrations

Uninstall an app from one or many workspaces, or an entire enterprise organization.

Required Params

• app_id - The ID of the app to uninstall. ex: A12345

Optional Params

• enterprise_id - The enterprise to completely uninstall the application from (across all workspaces). With an org-level token, this or team_ids is required. Exactly one of the arguments enterprise_id or team_ids is required to specify where the app should be removed. ex: E12345
• team_ids - IDs of the teams to uninstall from (max 100). With an org-level token, this or enterprise_id is required. Exactly one of the arguments enterprise_id or team_ids is required to specify where the app should be removed.

Errors the API can return:

• can_not_uninstall - This application can not be uninstalled via the API.
• 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.
• specify_enterprise_or_teams - Provide exactly one of enterprise_id or team_ids.
• 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 user is not authorized to perform this action
• 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.
• teams_not_found - One or more of the provided team_ids were not found.
• invalid_arguments - The method was called with invalid arguments.
• permission_denied - You do not have permission to uninstall applications from the reqeusted org or workspaces.
• 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.
• account_inactive - Authentication token is for a deleted user or workspace when using a bot token.
• too_many_teams - Too many IDs are present in team_ids.
• 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.
• app_not_found - The provided app_id was not found.
• 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.
• must_revoke_access - Organization-deployed apps cannot be uninstalled from specific workspaces using this API.
• enterprise_not_found - The provided enterprise_id was not found.