Skip to main content

admin.users.access.pause method

The features within are only available to Slack workspaces on an Enterprise plan.

Don't have a paid plan? Join the Developer Program and provision a fully-featured sandbox for free.

Facts​

DescriptionPause access across the organization for up to 1,000 frontline members. Success means the request was queued, not that all updates have completed.
Method Access
POST https://slack.com/api/admin.users.access.pause
Scopes
Content types
application/x-www-form-urlencoded
application/json
Rate LimitsTier 2: 20+ per minute

Arguments​

Required arguments

tokenstringRequired

Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.

Example: xxxx-xxxxxxxxx-xxxx
user_idsarrayRequired

IDs of frontline members in the authenticated organization. Valid users are queued; rejected IDs are returned in invalid_users.

Minimum: 1
Maximum: 1000

Optional arguments

reasonstringOptional

Optional explanation for the access change.

Usage info​

Pause organization-wide access for frontline members. Requires an organization-level token belonging to an org admin or owner, with the admin.users:write scope.

Targets must be frontline members in the authenticated organization. Valid users are queued even if other targets are invalid. A partially accepted request returns ok: false with error: "failed_for_some_users" and invalid_users containing each rejected user_id and reason. When every user is valid, the response returns ok: true and invalid_users: []. When none are valid, the method returns a failed_for_all_users error and queues nothing.

For a partially accepted request, correct and retry only the rejected IDs. Authentication and queueing failures return an error without queueing any users.

A successful response means the request was queued. Updates happen asynchronously, and failures during job execution are not returned in this response. Pausing an already-paused member preserves the original pause timestamp. Sessions are not invalidated.

Response​

All users were queued. Updates have not necessarily completed.

{
  "ok": true,
  "invalid_users": []
}

The valid user was queued, but another user was rejected. Correct and retry only the rejected ID.

{
  "ok": false,
  "error": "failed_for_some_users",
  "invalid_users": [
    {
      "user_id": "U222BBB222",
      "reason": "user_not_frontline_member"
    }
  ]
}

Errors​

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 parameter in the response.

Error
Description
access_denied

Access to a resource specified in the request is denied.

accesslimited

Access to this method is limited on the current network

account_inactive

Authentication token is for a deleted user or workspace when using a bot token.

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.

failed_for_all_users

No valid users were found. Nothing was queued. invalid_users lists the rejected IDs and reasons.

failed_for_some_users

Valid users were queued, but some users were rejected. invalid_users lists the rejected IDs and reasons. Correct and retry only those IDs.

failed_job_enqueue

The access change could not be queued. Retry the request.

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.

feature_not_enabled

Frontline access management is not enabled for this organization.

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 _. If you get this error, it is typically an indication that you have made a very malformed API call.

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.

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.

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.

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.

method_deprecated

The method has been deprecated.

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.

missing_scope

The token used is not granted the specific scope permissions required to complete this request.

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.

not_allowed_token_type

The token type used in this request is not allowed.

not_authed

No authentication token provided.

org_login_required

The workspace is undergoing an enterprise migration and will not be available until migration is complete.

ratelimited

The request has been ratelimited. Refer to the Retry-After header for when to retry the request.

request_timeout

The method was called via a POST request, but the POST data was either missing or truncated.

restricted_action

Only organization admins and owners can perform this action.

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.

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.

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 user token.

two_factor_setup_required

Two factor setup is required.