> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.dropboxapi.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.dropboxapi.com/_mcp/server.

# Members Suspend Batch

POST https://api.dropboxapi.com/2/team/members/suspend_batch
Content-Type: application/json

Launch a member suspension batch. The server enforces a maximum of 500 members.

**Required scope:** `members.write`

**Endpoint format:** [RPC](https://docs.dropboxapi.com/dropbox-api/docs/technical-reference/request-response-formats#rpc-endpoints)

**Authentication:** [Team](https://docs.dropboxapi.com/dropbox-api/docs/auth-types#team-authentication)

Reference: https://docs.dropboxapi.com/dropbox-api/api-reference/business-endpoints/team/members-suspend-batch

## Authentication

- `Authorization` header (bearer token, required) — Team-level OAuth 2.0 token issued to a Dropbox Business admin. Use `Authorization: Bearer <token>`. Obtain via the authorization code flow with team-scoped permissions. Grants access to team-wide administrative operations. You can generate a short-lived access token from the App Console; see [Testing with a generated token](https://docs.dropboxapi.com/dropbox-api/docs/oauth#testing-with-a-generated-token).

## Request

### Body (application/json)

This endpoint expects a members_page.MembersSuspendBatchArg.

- `members` (list of members_page.MembersSuspendBatchTarget, required) — Must contain between 1 and 500 targets. The launch handler also rejects duplicate client item IDs and duplicate member selectors.

## Response

### 200

Successful response

- `async_common.LaunchResultBase`

## Errors

### 401 Unauthorized Error

Bad or expired token

- `error` (auth_apiv2.AuthError, required) — Errors occurred during authentication.
- `error_summary` (string, required) — A human-readable summary of the error.

### 403 Forbidden Error

The user or team account doesn't have access to the endpoint or feature

- `error` (auth_apiv2.AccessError, required) — Error occurred because the account doesn't have permission to access the resource.
- `error_summary` (string, required) — A human-readable summary of the error.

### 409 Conflict Error

Endpoint-specific error

- `error` (members_page.MembersSuspendBatchError, required) — A typed launch rejection. Authorization failures continue to use the API v2 authentication/permission error surface.
- `error_summary` (string, required) — A human-readable summary of the error.
- `user_message` (2TeamMembersSuspendBatchPostResponsesContentApplicationJsonSchemaUserMessage, optional)

### 429 Too Many Requests Error

The app is making too many requests for the given user or team and is being rate limited. The app should wait for the number of seconds specified in the "Retry-After" response header before trying again.

- `error` (auth_apiv2.RateLimitError, required) — Error occurred because the app is being rate limited.
- `error_summary` (string, required) — A human-readable summary of the error.

### 500 Internal Server Error

Internal server error. An error occurred on the Dropbox servers. Check https://status.dropbox.com/ for announcements about Dropbox service issues.

- `any`

## Types

### members_page.MembersSuspendBatchTarget

One member selected for suspension. The opaque client item ID correlates the eventual report row with the caller's input without sending CSV data.

- `client_item_id` (string, required)
- `suspend_arg` (team.MembersDeactivateArg, required)

### async_common.LaunchResultBase.async_job_id

This response indicates that the processing is asynchronous. The string is an id that can be used to obtain the status of the asynchronous job.

- `.tag` (enum, required)
  - Allowed values: `async_job_id`
- `async_job_id` (string, required, nullable)

### auth_apiv2.AuthError

Errors occurred during authentication.

### auth_apiv2.AccessError

Error occurred because the account doesn't have permission to access the resource.

### members_page.MembersSuspendBatchError

A typed launch rejection. Authorization failures continue to use the API v2 authentication/permission error surface.

### 2TeamMembersSuspendBatchPostResponsesContentApplicationJsonSchemaUserMessage

- `locale` (string, optional)
- `text` (string, optional)

### auth_apiv2.RateLimitError

Error occurred because the app is being rate limited.

- `reason` (auth_apiv2.RateLimitReason, required) — The reason why the app is being rate limited.
- `retry_after` (uint64, optional, default: 1) — The number of seconds that the app should wait before making another request.

### team.MembersDeactivateArg

- `user` (team.UserSelectorArg, required) — Identity of user to remove/suspend/have their files moved.
- `wipe_data` (boolean, optional, default: true) — If provided, controls if the user's data will be deleted on their linked devices.

### auth_apiv2.AuthError.invalid_access_token

The access token is invalid. This can happen if the access token has been revoked by Dropbox or the user. To fix this, you should re-authenticate the user. Note: Access tokens that are not returned exactly as provisioned will return this error. Be sure not to truncate or otherwise malform access tokens provided by Dropbox.

- `.tag` (enum, required)
  - Allowed values: `invalid_access_token`

### auth_apiv2.AuthError.invalid_select_user

The user specified in 'Dropbox-API-Select-User' is no longer on the team.

- `.tag` (enum, required)
  - Allowed values: `invalid_select_user`

### auth_apiv2.AuthError.invalid_select_admin

The user specified in 'Dropbox-API-Select-Admin' is not a Dropbox Business team admin.

- `.tag` (enum, required)
  - Allowed values: `invalid_select_admin`

### auth_apiv2.AuthError.user_suspended

The user has been suspended.

- `.tag` (enum, required)
  - Allowed values: `user_suspended`

### auth_apiv2.AuthError.expired_access_token

The access token has expired.

- `.tag` (enum, required)
  - Allowed values: `expired_access_token`

### auth_apiv2.AuthError.missing_scope

The access token does not have the required scope to access the route.

- `.tag` (enum, required)
  - Allowed values: `missing_scope`
- `required_scope` (string, required) — The required scope to access the route.

### auth_apiv2.AuthError.route_access_denied

The route is not available to public.

- `.tag` (enum, required)
  - Allowed values: `route_access_denied`

### auth_apiv2.AuthError.other

An open-union catch-all: a variant added to this union after your API client's spec was generated. Its ".tag" is a value not listed among the known variants above; treat it as an unrecognized/forward-compatible case.

- `.tag` (string, optional)

### auth_apiv2.AccessError.invalid_account_type

Current account type cannot access the resource.

- `.tag` (enum, required)
  - Allowed values: `invalid_account_type`
- `invalid_account_type` (auth_apiv2.InvalidAccountTypeError, required)

### auth_apiv2.AccessError.paper_access_denied

Current account cannot access Paper.

- `.tag` (enum, required)
  - Allowed values: `paper_access_denied`
- `paper_access_denied` (auth_apiv2.PaperAccessError, required)

### auth_apiv2.AccessError.team_access_denied

Team doesn't have permission to access.

- `.tag` (enum, required)
  - Allowed values: `team_access_denied`

### auth_apiv2.AccessError.no_permission

Caller does not have permission to access the resource.

- `.tag` (enum, required)
  - Allowed values: `no_permission`
- `no_permission` (auth_apiv2.NoPermissionError, required)

### auth_apiv2.AccessError.other

An open-union catch-all: a variant added to this union after your API client's spec was generated. Its ".tag" is a value not listed among the known variants above; treat it as an unrecognized/forward-compatible case.

- `.tag` (string, optional)

### members_page.MembersSuspendBatchError.too_many_members

The request contains more than 500 members.

- `.tag` (enum, required)
  - Allowed values: `too_many_members`

### members_page.MembersSuspendBatchError.duplicate_client_item_id

More than one target uses the same client item ID.

- `.tag` (enum, required)
  - Allowed values: `duplicate_client_item_id`

### members_page.MembersSuspendBatchError.duplicate_team_member_id

More than one target selects the same team member.

- `.tag` (enum, required)
  - Allowed values: `duplicate_team_member_id`

### members_page.MembersSuspendBatchError.acting_admin

The acting administrator cannot suspend their own account.

- `.tag` (enum, required)
  - Allowed values: `acting_admin`

### members_page.MembersSuspendBatchError.last_admin

Suspending the selected members would leave the team without an active admin.

- `.tag` (enum, required)
  - Allowed values: `last_admin`

### members_page.MembersSuspendBatchError.other

An open-union catch-all: a variant added to this union after your API client's spec was generated. Its ".tag" is a value not listed among the known variants above; treat it as an unrecognized/forward-compatible case.

- `.tag` (string, optional)

### auth_apiv2.RateLimitReason

### team.UserSelectorArg

Argument for selecting a single user, either by team_member_id, external_id or email.

### auth_apiv2.InvalidAccountTypeError

### auth_apiv2.PaperAccessError

### auth_apiv2.NoPermissionError

### auth_apiv2.RateLimitReason.too_many_requests

You are making too many requests in the past few minutes.

- `.tag` (enum, required)
  - Allowed values: `too_many_requests`

### auth_apiv2.RateLimitReason.too_many_write_operations

There are currently too many write operations happening in the user's Dropbox.

- `.tag` (enum, required)
  - Allowed values: `too_many_write_operations`

### auth_apiv2.RateLimitReason.other

An open-union catch-all: a variant added to this union after your API client's spec was generated. Its ".tag" is a value not listed among the known variants above; treat it as an unrecognized/forward-compatible case.

- `.tag` (string, optional)

### team.UserSelectorArg.team_member_id

- `.tag` (enum, required)
  - Allowed values: `team_member_id`
- `team_member_id` (string, required, nullable)

### team.UserSelectorArg.external_id

- `.tag` (enum, required)
  - Allowed values: `external_id`
- `external_id` (string, required, nullable)

### team.UserSelectorArg.email

- `.tag` (enum, required)
  - Allowed values: `email`
- `email` (string, required, nullable)

### auth_apiv2.InvalidAccountTypeError.endpoint

Current account type doesn't have permission to access this endpoint.

- `.tag` (enum, required)
  - Allowed values: `endpoint`

### auth_apiv2.InvalidAccountTypeError.feature

Current account type doesn't have permission to access this feature.

- `.tag` (enum, required)
  - Allowed values: `feature`

### auth_apiv2.InvalidAccountTypeError.other

An open-union catch-all: a variant added to this union after your API client's spec was generated. Its ".tag" is a value not listed among the known variants above; treat it as an unrecognized/forward-compatible case.

- `.tag` (string, optional)

### auth_apiv2.PaperAccessError.paper_disabled

Paper is disabled.

- `.tag` (enum, required)
  - Allowed values: `paper_disabled`

### auth_apiv2.PaperAccessError.not_paper_user

The provided user has not used Paper yet.

- `.tag` (enum, required)
  - Allowed values: `not_paper_user`

### auth_apiv2.PaperAccessError.other

An open-union catch-all: a variant added to this union after your API client's spec was generated. Its ".tag" is a value not listed among the known variants above; treat it as an unrecognized/forward-compatible case.

- `.tag` (string, optional)

### auth_apiv2.NoPermissionError.unauthorized_account_id_usage

Current caller does not have permission to access the account information for one or more of the specified account IDs.

- `.tag` (enum, required)
  - Allowed values: `unauthorized_account_id_usage`
- `unauthorized_account_ids` (list of string, required) — The account IDs that the caller does not have permission to use.

### auth_apiv2.NoPermissionError.other

An open-union catch-all: a variant added to this union after your API client's spec was generated. Its ".tag" is a value not listed among the known variants above; treat it as an unrecognized/forward-compatible case.

- `.tag` (string, optional)

## Examples

**Request**

```json
{
  "members": [
    {
      "client_item_id": "string",
      "suspend_arg": {
        "user": {
          ".tag": "team_member_id",
          "team_member_id": "dbmid:efgh5678"
        },
        "wipe_data": false
      }
    }
  ]
}
```

**Response**

```json
{
  ".tag": "async_job_id",
  "async_job_id": "34g93hh34h04y384084"
}
```

**SDK Code**

```python
import requests

url = "https://api.dropboxapi.com/2/team/members/suspend_batch"

payload = { "members": [
        {
            "client_item_id": "string",
            "suspend_arg": {
                "user": {
                    ".tag": "team_member_id",
                    "team_member_id": "dbmid:efgh5678"
                },
                "wipe_data": False
            }
        }
    ] }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.dropboxapi.com/2/team/members/suspend_batch';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"members":[{"client_item_id":"string","suspend_arg":{"user":{".tag":"team_member_id","team_member_id":"dbmid:efgh5678"},"wipe_data":false}}]}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.dropboxapi.com/2/team/members/suspend_batch"

	payload := strings.NewReader("{\n  \"members\": [\n    {\n      \"client_item_id\": \"string\",\n      \"suspend_arg\": {\n        \"user\": {\n          \".tag\": \"team_member_id\",\n          \"team_member_id\": \"dbmid:efgh5678\"\n        },\n        \"wipe_data\": false\n      }\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.dropboxapi.com/2/team/members/suspend_batch")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"members\": [\n    {\n      \"client_item_id\": \"string\",\n      \"suspend_arg\": {\n        \"user\": {\n          \".tag\": \"team_member_id\",\n          \"team_member_id\": \"dbmid:efgh5678\"\n        },\n        \"wipe_data\": false\n      }\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.dropboxapi.com/2/team/members/suspend_batch")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"members\": [\n    {\n      \"client_item_id\": \"string\",\n      \"suspend_arg\": {\n        \"user\": {\n          \".tag\": \"team_member_id\",\n          \"team_member_id\": \"dbmid:efgh5678\"\n        },\n        \"wipe_data\": false\n      }\n    }\n  ]\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.dropboxapi.com/2/team/members/suspend_batch', [
  'body' => '{
  "members": [
    {
      "client_item_id": "string",
      "suspend_arg": {
        "user": {
          ".tag": "team_member_id",
          "team_member_id": "dbmid:efgh5678"
        },
        "wipe_data": false
      }
    }
  ]
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.dropboxapi.com/2/team/members/suspend_batch");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"members\": [\n    {\n      \"client_item_id\": \"string\",\n      \"suspend_arg\": {\n        \"user\": {\n          \".tag\": \"team_member_id\",\n          \"team_member_id\": \"dbmid:efgh5678\"\n        },\n        \"wipe_data\": false\n      }\n    }\n  ]\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = ["members": [
    [
      "client_item_id": "string",
      "suspend_arg": [
        "user": [
          ".tag": "team_member_id",
          "team_member_id": "dbmid:efgh5678"
        ],
        "wipe_data": false
      ]
    ]
  ]] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.dropboxapi.com/2/team/members/suspend_batch")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```