Groups Update

POST

https://api.dropboxapi.com/2/team/groups/update

POST

/2/team/groups/update

import requests
url = "https://api.dropboxapi.com/2/team/groups/update"
payload = {
    "group": {
        ".tag": "group_id",
        "group_id": "g:e2db7665347abcd600000000001a2b3c"
    },
    "new_group_external_id": "sales-234",
    "new_group_management_type": { ".tag": "company_managed" },
    "new_group_name": "Europe west sales"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())

Response headers

HTTP/1.1 200 OK
X-Dropbox-Request-Id: string

{
  "created": 1447255518000,
  "group_id": "g:e2db7665347abcd600000000001a2b3c",
  "group_management_type": {
    ".tag": "user_managed"
  },
  "group_name": "project launch",
  "member_count": 5,
  "members": [
    {
      "access_type": {
        ".tag": "member",
        "member": null
      },
      "profile": {
        "email": "mary@lamb.com",
        "email_verified": true,
        "membership_type": {
          ".tag": "full"
        },
        "name": {
          "abbreviated_name": "FF",
          "display_name": "Franz Ferdinand (Personal)",
          "familiar_name": "Franz",
          "given_name": "Franz",
          "surname": "Ferdinand"
        },
        "status": {
          ".tag": "active"
        },
        "team_member_id": "dbmid:1234567",
        "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc",
        "joined_on": "2015-05-12T15:50:38Z",
        "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128",
        "secondary_emails": [
          {
            "email": "apple@orange.com",
            "is_verified": true
          },
          {
            "email": "banana@honeydew.com",
            "is_verified": true
          },
          {
            "email": "grape@strawberry.com",
            "is_verified": false
          }
        ]
      }
    }
  ]
}

Updates a group’s name and/or external ID.

Permission : Team member management.

Required scope: groups.write

Endpoint format: RPC

Authentication: Team

Authentication

AuthorizationBearer

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.

Request

This endpoint expects an object.

groupobjectRequired

Specify a group.

Variant:

team_apiv2.GroupSelector.group_idobjectRequired

Group ID.

new_group_external_idstring or nullOptional

Optional argument. New group external ID. If the argument is None, the group’s external_id won’t be updated. If the argument is empty string, the group’s external id will be cleared.

new_group_management_typeobject or nullOptional

Set new group management type, if provided.

Variant:

team_common.GroupManagementType.user_managedobjectRequired

A group which is managed by selected users.

new_group_namestring or nullOptional

Optional argument. Set group name to this if provided.

return_membersbooleanOptionalDefaults to true

Whether to return the list of members in the group. Note that the default value will cause all the group members to be returned in the response. This may take a long time for large groups.

Response headers

X-Dropbox-Request-IdstringOptional

A unique identifier for the request, useful for debugging and support.

Response

Successful response

createduint64>=0

The group creation time as a UTC timestamp in milliseconds since the Unix epoch.

group_idstring

group_management_typeobject

Who is allowed to manage the group.

Variant:

team_common.GroupManagementType.user_managedobject

A group which is managed by selected users.

group_namestring

group_external_idstring or nullOptional

External ID of group. This is an arbitrary ID that an admin can attach to a group.

member_countuint or nullOptional0-4294967295

The number of members in the group.

memberslist of objects or nullOptional

List of group members.

Errors

401

Unauthorized Error

403

Forbidden Error

409

Conflict Error

429

Too Many Requests Error

500

Internal Server Error