Members Set Profile

POST

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

POST

/2/team/members/set_profile

import requests
url = "https://api.dropboxapi.com/2/team/members/set_profile"
payload = {
    "user": {
        ".tag": "team_member_id",
        "team_member_id": "dbmid:efgh5678"
    },
    "new_email": "t.smith@domain.com",
    "new_surname": "Smith"
}
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

{
  "profile": {
    "email": "tami@seagull.com",
    "email_verified": false,
    "groups": [
      "g:e2db7665347abcd600000000001a2b3c"
    ],
    "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"
    },
    "root_folder_id": "30",
    "status": {
      ".tag": "active"
    },
    "team_member_id": "dbmid:FDFSVF-DFSDF",
    "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc",
    "external_id": "244423",
    "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": "grape@strawberry.com",
        "is_verified": false
      },
      {
        "email": "apple@orange.com",
        "is_verified": true
      }
    ]
  },
  "role": {
    ".tag": "member_only"
  }
}

Updates a team member’s profile.

Permission : Team member management.

Required scope: members.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.

userobjectRequired

Identity of user whose profile will be set.

Variant:

team.UserSelectorArg.team_member_idobjectRequired

new_emailstring or nullOptionalformat: "^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$"<=255 characters

New email for member.

new_external_idstring or nullOptional<=64 characters

New external ID for member.

new_given_namestring or nullOptionalformat: "[^\/:?*<>\"|]*"<=50 characters

New given name for member.

new_is_directory_restrictedboolean or nullOptional

New value for whether the user is a directory restricted user.

new_persistent_idstring or nullOptional

New persistent ID. This field only available to teams using persistent ID SAML configuration.

new_surnamestring or nullOptionalformat: "[^\/:?*<>\"|]*"<=50 characters

New surname for member.

Response headers

X-Dropbox-Request-IdstringOptional

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

Response

Successful response

profileobject

Profile of a user as a member of a team.

roleobject

The user's role in the team.

Variant:

team.AdminTier.team_adminobject

User is an administrator of the team - has all permissions.

Errors

401

Unauthorized Error

403

Forbidden Error

409

Conflict Error

429

Too Many Requests Error

500

Internal Server Error