Members Add v2

POST

https://api.dropboxapi.com/2/team/members/add_v2

POST

/2/team/members/add_v2

import requests
url = "https://api.dropboxapi.com/2/team/members/add_v2"
payload = {
    "new_members": [
        {
            "member_email": "tom.s@company.com",
            "member_external_id": "company_id:342432",
            "member_given_name": "Tom",
            "member_surname": "Silverstone",
            "role_ids": ["pid_dbtmr:2345"]
        }
    ],
    "force_async": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())

{
  ".tag": "complete",
  "complete": [
    {
      ".tag": "success",
      "profile": {
        "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc",
        "email": "tami@seagull.com",
        "email_verified": false,
        "external_id": "244423",
        "groups": [
          "g:e2db7665347abcd600000000001a2b3c"
        ],
        "joined_on": "2015-05-12T15:50:38Z",
        "member_folder_id": "20",
        "membership_type": {
          ".tag": "full"
        },
        "name": {
          "abbreviated_name": "FF",
          "display_name": "Franz Ferdinand (Personal)",
          "familiar_name": "Franz",
          "given_name": "Franz",
          "surname": "Ferdinand"
        },
        "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128",
        "root_folder_id": "30",
        "secondary_emails": [
          {
            "email": "grape@strawberry.com",
            "is_verified": false
          },
          {
            "email": "apple@orange.com",
            "is_verified": true
          }
        ],
        "status": {
          ".tag": "active"
        },
        "team_member_id": "dbmid:FDFSVF-DFSDF"
      },
      "roles": [
        {
          "description": "Add, remove, and manage member accounts.",
          "name": "User management admin",
          "role_id": "pid_dbtmr:3456"
        }
      ]
    }
  ]
}

Adds members to a team.

Permission : Team member management

A maximum of 20 members can be specified in a single call.

If no Dropbox account exists with the email address specified, a new Dropbox account will be created with the given email address, and that account will be invited to the team.

If a personal Dropbox account exists with the email address specified in the call, this call will create a placeholder Dropbox account for the user on the team and send an email inviting the user to migrate their existing personal account onto the team.

Required scope: members.write

Endpoint format: RPC

Authentication: Team

Adds members to a team. Permission : Team member management A maximum of 20 members can be specified in a single call. If no Dropbox account exists with the email address specified, a new Dropbox account will be created with the given email address, and that account will be invited to the team. If a personal Dropbox account exists with the email address specified in the call, this call will create a placeholder Dropbox account for the user on the team and send an email inviting the user to migrate their existing personal account onto the team. **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)

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.

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

This endpoint expects an object.

new_memberslist of objectsRequired

Details of new members to be added to the team.

force_asyncbooleanOptionalDefaults to false

Whether to force the add to happen asynchronously.

Response headers

X-Dropbox-Request-IdstringOptional

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

Response

Successful response

Variant:

team.MembersAddLaunchV2Result.async_job_idobject

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.

Errors

401

Unauthorized Error

403

Forbidden Error

409

Conflict Error

429

Too Many Requests Error

500

Internal Server Error