Groups Create

POST

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

POST

/2/team/groups/create

import requests
url = "https://api.dropboxapi.com/2/team/groups/create"
payload = {
    "group_name": "Europe sales",
    "group_external_id": "group-134"
}
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
          }
        ]
      }
    }
  ]
}

Creates a new, empty group, with a requested name.

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.

group_namestringRequired

Group name.

add_creator_as_ownerbooleanOptionalDefaults to false

Automatically add the creator of the group.

group_external_idstring or nullOptional

The creator of a team can associate an arbitrary external ID to the group.

group_management_typeobject or nullOptional

Whether the team can be managed by selected users, or only by team admins.

Variant:

team_common.GroupManagementType.user_managedobjectRequired

A group which is managed by selected users.

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