Dropbox: Updates a group's name and or external ID

← Team operations · Get started

Operation dropbox.team_groups_update

Provider route: POST /2/team/groups/update. 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"]["groupsUpdate"]>[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.groupsUpdate(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.groups_update(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 Updates a group’s name and or external ID — request body — body

Referenced models: Deletes a group — request body — headers Dropbox-API-Path-Root, Updates a group’s name and or external ID — 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 Updates a group’s name and or external ID — response body

Referenced models: Updates a group’s name and or external ID — response body

Schemas

3 more schemas are linked from the tables above, on the schema pages.

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)$)

Updates a group's name and or external ID — response body

Field	Type	Presence	Description and constraints
$	object	Root	Full description of a group.
group_name	string	Required within parent
group_id	string	Required within parent
group_external_id	JSON	Optional
group_external_id (anyOf 1)	string	Alternative
group_external_id (anyOf 2)	null	Alternative
member_count	JSON	Optional
member_count (anyOf 1)	JSON	Alternative
member_count (anyOf 1) (anyOf 1)	integer	Alternative	Minimum: 0
member_count (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
member_count (anyOf 2)	null	Alternative
group_management_type	Model	Required within parent	Expand Updates a group's name and or external ID — response body — group management type
members	JSON	Optional
members (anyOf 1)	array	Alternative
members (anyOf 1)[]	Model	Each item	Expand Lists members of a group — response body — members item
members (anyOf 2)	null	Alternative
created	JSON	Required within parent
created (anyOf 1)	integer	Alternative	Minimum: 0
created (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Updates a group's name and or external ID — response body — group management type, Lists members of a group — response body — members item

Updates a group's name and or external ID — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
return_members	boolean	Optional
group	Model	Required within parent	Expand Deletes a group — request body — body
new_group_name	JSON	Optional
new_group_name (anyOf 1)	string	Alternative
new_group_name (anyOf 2)	null	Alternative
new_group_external_id	JSON	Optional
new_group_external_id (anyOf 1)	string	Alternative
new_group_external_id (anyOf 2)	null	Alternative
new_group_management_type	JSON	Optional
new_group_management_type (anyOf 1)	Model	Alternative	Expand Creates a new, empty group, with a requested name — request body — body group management type The group type determines how a group is managed
new_group_management_type (anyOf 2)	null	Alternative

Referenced models: Creates a new, empty group, with a requested name — request body — body group management type The group type determines how a group is managed, Deletes a group — request body — body

Updates a group's name and or external ID — response body — group management type

Field	Type	Presence	Description and constraints
$	JSON	Root	The group type determines how a group is managed.
$ (anyOf 1)	string	Alternative	Known values: user_managed, company_managed, system_managed
$ (anyOf 2)	object	Alternative
$ (anyOf 2)..tag	string	Required within parent	Must equal: user_managed
$ (anyOf 3)	object	Alternative
$ (anyOf 3)..tag	string	Required within parent	Must equal: company_managed
$ (anyOf 4)	object	Alternative
$ (anyOf 4)..tag	string	Required within parent	Must equal: system_managed
$ (anyOf 5)	object	Alternative	A tag this contract version does not list (Dropbox's other).
$ (anyOf 5)..tag	string	Required within parent	Pattern: ^(?!(?:user_managed|company_managed|system_managed)$)

Lists members of a group — response body — members item

Field	Type	Presence	Description and constraints
$	object	Root	Profile of group member, and role in group.
profile	Model	Required within parent	Expand List member space limits excluded users — response body — users item
access_type	Model	Required within parent	Expand Lists members of a group — response body — members item access type

Referenced models: Lists members of a group — response body — members item access type, List member space limits excluded users — response body — users item

Creates a new, empty group, with a requested name — request body — body group management type The group type determines how a group is managed

Field	Type	Presence	Description and constraints
$	JSON	Root	The group type determines how a group is managed.
$ (anyOf 1)	string	Alternative	One of: user_managed, company_managed, system_managed
$ (anyOf 2)	object	Alternative
$ (anyOf 2)..tag	string	Required within parent	Must equal: user_managed
$ (anyOf 3)	object	Alternative
$ (anyOf 3)..tag	string	Required within parent	Must equal: company_managed
$ (anyOf 4)	object	Alternative
$ (anyOf 4)..tag	string	Required within parent	Must equal: system_managed
$ (anyOf 5)	object	Alternative	A tag this contract version does not list (Dropbox's other).
$ (anyOf 5)..tag	string	Required within parent	Pattern: ^(?!(?:user_managed|company_managed|system_managed)$)

Deletes a group — request body — body

Field	Type	Presence	Description and constraints
$	JSON	Root	Argument for selecting a single group, either by group_id or by external group ID.
$ (anyOf 1)	object	Alternative
$ (anyOf 1)..tag	string	Required within parent	Must equal: group_id
$ (anyOf 1).group_id	string	Required within parent
$ (anyOf 2)	object	Alternative
$ (anyOf 2)..tag	string	Required within parent	Must equal: group_external_id
$ (anyOf 2).group_external_id	string	Required within parent

Lists members of a group — response body — members item access type

Field	Type	Presence	Description and constraints
$	JSON	Root	Role of a user in group.
$ (anyOf 1)	string	Alternative	Known values: member, owner
$ (anyOf 2)	object	Alternative
$ (anyOf 2)..tag	string	Required within parent	Must equal: member
$ (anyOf 3)	object	Alternative
$ (anyOf 3)..tag	string	Required within parent	Must equal: owner

Updates a team member's profile — team members Set Profile — response body — profile secondary emails array item

Field	Type	Presence	Description and constraints
$	object	Root
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}$)$
is_verified	boolean	Required within parent

Updates a team member's profile — team members Set Profile — response body — profile status

Field	Type	Presence	Description and constraints
$	JSON	Root	The user's status as a member of a specific team.
$ (anyOf 1)	string	Alternative	Known values: active, invited, suspended
$ (anyOf 2)	object	Alternative
$ (anyOf 2)..tag	string	Required within parent	Must equal: active
$ (anyOf 3)	object	Alternative
$ (anyOf 3)..tag	string	Required within parent	Must equal: invited
$ (anyOf 4)	object	Alternative
$ (anyOf 4)..tag	string	Required within parent	Must equal: suspended
$ (anyOf 5)	object	Alternative
$ (anyOf 5)..tag	string	Required within parent	Must equal: removed
$ (anyOf 5).is_recoverable	boolean	Required within parent
$ (anyOf 5).is_disconnected	boolean	Required within parent

Policy, approvals and errors

SDK function policy ID: dropbox.team_groups_update. Catalog operation: team/groups_update. 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: ["groups.write"]

Official provider source