Slack. Web. Admin. InviteRequests
(SlackKit v1.0.0-alpha.0)
View Source
Summary
Functions
Approve a workspace invite request.
Deny a workspace invite request.
List all pending workspace invite requests.
Functions
Approve a workspace invite request.
API reference
Rate limit: Tier 2: 20+ per minute
Scopes:
- User token:
admin.invites:write
Required Params
invite_request_id- ID of the request to invite. ex:Ir1234
Optional Params
team_id- ID for the workspace where the invite request was made.
Errors the API can return:
already_processed- Theinvite_request_idpassed has already been approved or denied.failed_to_send_invite- The actual invite (separate from approval) failed to process. This may happen because the user is disabled, already in the team, etc.feature_not_enabled- The Invite Request Admin APIs are not enabled for this team.invalid_request- Theinvite_request_idpassed is invalid.not_an_admin- This token doesn't have admin privileges.team_not_found- Theteam_idspecified wasn't found.
See the Common Errors guide for errors returned by every Web API method.
Deny a workspace invite request.
API reference
Rate limit: Tier 2: 20+ per minute
Scopes:
- User token:
admin.invites:write
Required Params
invite_request_id- ID of the request to invite. ex:Ir1234
Optional Params
team_id- ID for the workspace where the invite request was made.
Errors the API can return:
already_processed- Theinvite_request_idpassed has already been approved or denied.feature_not_enabled- The Invite Request Admin APIs feature is not enabledinvalid_request- Theinvite_request_idpassed is invalid.not_an_admin- This token doesn't have admin privileges.team_not_found- Theteam_idspecified wasn't found.
See the Common Errors guide for errors returned by every Web API method.
List all pending workspace invite requests.
API reference
Rate limit: Tier 2: 20+ per minute
Scopes:
- User token:
admin.invites:read
Optional Params
cursor- Value of thenext_cursorfield sent as part of the previous API response ex:5cweb43limit- The number of results that will be returned by the API on each invocation. Must be between 1 - 1000, both inclusive ex:100team_id- ID for the workspace where the invite requests were made.
Errors the API can return:
feature_not_enabled- The Invite Request Admin APIs feature is not enablednot_an_admin- This token doesn't have admin privileges.team_not_found- Theteam_idspecified wasn't found.
See the Common Errors guide for errors returned by every Web API method.