Members Set Profile v2

POST

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

POST

/2/team/members/set_profile_v2

import requests
url = "https://api.dropboxapi.com/2/team/members/set_profile_v2"
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())

{
  "member_info": {
    "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
        }
      ]
    },
    "roles": [
      {
        "description": "Add, remove, and manage member accounts.",
        "name": "User management admin",
        "role_id": "pid_dbtmr:3456"
      }
    ]
  }
}

Updates a team member’s profile.

Permission : Team member management.

Required scope: members.write

Endpoint format: RPC

Authentication: Team

Updates a team member's profile. Permission : Team member management. **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.

userobjectRequired

Identity of user whose profile will be set.

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

member_infoobject

Member info, after the change.

Errors

401

Unauthorized Error

403

Forbidden Error

409

Conflict Error

429

Too Many Requests Error

500

Internal Server Error