Dropbox: Launch a member suspension batch

← Team operations · Get started

Operation dropbox.team_members_suspend_batch

Provider route: POST /2/team/members/suspend_batch. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/dropbox with npm, or alter-sdk-dropbox with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { DropboxIntegration } from "@alter-ai/dropbox";

async function execute(input: Parameters<DropboxIntegration["team"]["membersSuspendBatch"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new DropboxIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.team.membersSuspendBatch(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_dropbox import DropboxIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = DropboxIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.team.members_suspend_batch(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
headers	object	Optional	Additional keys: not allowed
headers.Dropbox-API-Path-Root	Model	Optional	Expand Deletes a group — request body — headers Dropbox-API-Path-Root
headers.Dropbox-API-Select-User	string	Optional
headers.Dropbox-API-Select-Admin	string	Optional
body	Model	Required within parent	Expand Launch a member suspension batch — request body — body

Referenced models: Deletes a group — request body — headers Dropbox-API-Path-Root, Launch a member suspension batch — request body — body

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Launch a member suspension batch — response body

Referenced models: Launch a member suspension batch — response body

Schemas

Launch a member suspension batch — response body

Field	Type	Presence	Description and constraints
$	JSON	Root	Result returned by methods that launch an asynchronous job. A method who may either launch an asynchronous job, or complete the request synchronously, can use this union by extending it, and adding a 'complete' field with the type of the synchronous response. See LaunchEmptyResult for an example.
$ (anyOf 1)	object	Alternative
$ (anyOf 1)..tag	string	Required within parent	Must equal: async_job_id
$ (anyOf 1).async_job_id	string	Required within parent	Minimum length: 1

Deletes a group — request body — headers Dropbox-API-Path-Root

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	string	Alternative	One of: home
$ (anyOf 2)	object	Alternative
$ (anyOf 2)..tag	string	Required within parent	Must equal: home
$ (anyOf 3)	object	Alternative
$ (anyOf 3)..tag	string	Required within parent	Must equal: root
$ (anyOf 3).root	string	Required within parent	Pattern: ^(?:[-_0-9a-zA-Z:]+)$
$ (anyOf 4)	object	Alternative
$ (anyOf 4)..tag	string	Required within parent	Must equal: namespace_id
$ (anyOf 4).namespace_id	string	Required within parent	Pattern: ^(?:[-_0-9a-zA-Z:]+)$
$ (anyOf 5)	object	Alternative	A tag this contract version does not list (Dropbox's other).
$ (anyOf 5)..tag	string	Required within parent	Pattern: ^(?!(?:home|root|namespace_id)$)

Launch a member suspension batch — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Launches one action-specific member suspension batch job.
members	array	Required within parent	Maximum items: 500 Minimum items: 1
members[]	Model	Each item	Expand Launch a member suspension batch — request body — body members item

Referenced models: Launch a member suspension batch — request body — body members item

Launch a member suspension batch — request body — body members item

Field	Type	Presence	Description and constraints
$	object	Root	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 within parent	Maximum length: 128 Minimum length: 1
suspend_arg	Model	Required within parent	Expand Suspend a member from a team — request body — body

Referenced models: Suspend a member from a team — request body — body

Suspend a member from a team — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
user	Model	Required within parent	Expand Sends welcome email to pending team member — request body — body
wipe_data	boolean	Optional

Referenced models: Sends welcome email to pending team member — request body — body

Sends welcome email to pending team member — request body — body

Field	Type	Presence	Description and constraints
$	JSON	Root	Argument for selecting a single user, either by team_member_id, external_id or email.
$ (anyOf 1)	object	Alternative
$ (anyOf 1)..tag	string	Required within parent	Must equal: team_member_id
$ (anyOf 1).team_member_id	string	Required within parent
$ (anyOf 2)	object	Alternative
$ (anyOf 2)..tag	string	Required within parent	Must equal: external_id
$ (anyOf 2).external_id	string	Required within parent	Maximum length: 64
$ (anyOf 3)	object	Alternative
$ (anyOf 3)..tag	string	Required within parent	Must equal: email
$ (anyOf 3).email	string	Required within parent	Maximum length: 255 Pattern: ^(?:^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$)$

Policy, approvals and errors

SDK function policy ID: dropbox.team_members_suspend_batch. Catalog operation: team/members_suspend_batch. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["members.write"]

Official provider source