Slack.Web.Admin.Apps.Requests (SlackKit v1.0.0-alpha.0)

View Source

Summary

Functions

Cancel app request for team

List app requests for a team/workspace.

Functions

cancel(request_id, optional_params \\ %{})

Cancel app request for team

API reference

Rate limit: Tier 2: 20+ per minute
Scopes:

View on docs.slack.dev ↗

Required Params

  • request_id - The id of the request to cancel. ex: Ar12345

Optional Params

  • enterprise_id - The ID of the enterprise where this request belongs ex: E12345
  • team_id - The ID of the workspace where this request belongs ex: T12345

Errors the API can return:

  • app_management_app_not_installed_on_org - The app management app must be installed on the org.
  • feature_not_enabled - Returned when the Admin APIs feature is not enabled for this team
  • invalid_request_id - The request_id passed is invalid.
  • not_an_admin - This method is only accessible by org owners and admins
  • request_already_resolved - The app request has already been resolved
  • restricted_action - User is not authorized to perform this action
  • team_not_found - Returned when team id is not found.
  • too_many_teams_provided - Please provide only team_id OR enterprise_id

See the Common Errors guide for errors returned by every Web API method.

list(optional_params \\ %{})

List app requests for a team/workspace.

API reference

Rate limit: Tier 2: 20+ per minute
Scopes:

View on docs.slack.dev ↗

Optional Params

  • certified - Include requests for certified apps
  • cursor - Set cursor to next_cursor returned by the previous call to list items in the next page ex: 5c3e53d5
  • enterprise_id -
  • limit - The maximum number of items to return. Must be between 1 - 1000 both inclusive. ex: 100
  • team_id -

Errors the API can return:

  • app_management_app_not_installed_on_org - The app management app must be installed on the org.
  • enterprise_not_found - Returned when enterprise id is not found.
  • feature_not_enabled - Returned when the Admin APIs feature is not enabled for this team
  • invalid_cursor - Value passed for cursor was not valid or is no longer valid.
  • no_team_or_enterprise_provided - Must provide team ID or enterprise ID
  • not_allowed - The user is not allowed to access this API method
  • not_an_admin - This method is only accessible by org owners and admins
  • restricted_action - The action is restricted for this team
  • team_not_found - Returned when team id is not found.
  • too_many_teams_provided - Please provide only team_id OR enterprise_id
  • user_is_restricted - This method is only accessible by org owners, admins, and integration managers

See the Common Errors guide for errors returned by every Web API method.