← Team operations · All schemas
Retrieves information about one or more groups — response body — item
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | |
$ (anyOf 1) | object | Alternative | |
$ (anyOf 1)..tag | string | Required within parent | Must equal: id_not_found |
$ (anyOf 1).id_not_found | string | Required within parent | |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: group_info |
$ (anyOf 2).group_name | string | Required within parent | |
$ (anyOf 2).group_id | string | Required within parent | |
$ (anyOf 2).group_external_id | JSON | Optional | |
$ (anyOf 2).group_external_id (anyOf 1) | string | Alternative | |
$ (anyOf 2).group_external_id (anyOf 2) | null | Alternative | |
$ (anyOf 2).member_count | JSON | Optional | |
$ (anyOf 2).member_count (anyOf 1) | JSON | Alternative | |
$ (anyOf 2).member_count (anyOf 1) (anyOf 1) | integer | Alternative | Minimum: 0 |
$ (anyOf 2).member_count (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 2).member_count (anyOf 2) | null | Alternative | |
$ (anyOf 2).group_management_type | Model | Required within parent | Expand Updates a group's name and or external ID — response body — group management type |
$ (anyOf 2).members | JSON | Optional | |
$ (anyOf 2).members (anyOf 1) | array | Alternative | |
$ (anyOf 2).members (anyOf 1)[] | Model | Each item | Expand Lists members of a group — response body — members item |
$ (anyOf 2).members (anyOf 2) | null | Alternative | |
$ (anyOf 2).created | JSON | Required within parent | |
$ (anyOf 2).created (anyOf 1) | integer | Alternative | Minimum: 0 |
$ (anyOf 2).created (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Updates a group's name and or external ID — response body — group management type, Lists members of a group — response body — members item
Retrieves metadata for team folders — request body — body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
team_folder_ids | array | Required within parent | Minimum items: 1 |
team_folder_ids[] | string | Each item | Pattern: ^(?:[-_0-9a-zA-Z:]+)$ |
Retrieves metadata for team folders — response body — item
Referenced models: Changes an active team folder's name — response body — content sync settings item, Changes an active team folder's name — response body — sync setting, Changes an active team folder's name — response body — status
Returns a list of all team-accessible namespaces — response body
Referenced models: Returns a list of all team-accessible namespaces — response body — namespaces item
Returns a list of all team-accessible namespaces — response body — namespaces item
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | Properties of a namespace. |
name | string | Required within parent | |
namespace_id | string | Required within parent | Pattern: ^(?:[-_0-9a-zA-Z:]+)$ |
namespace_type | Model | Required within parent | Expand Returns a list of all team-accessible namespaces — response body — namespaces item namespace type |
team_member_id | JSON | Optional | |
team_member_id (anyOf 1) | string | Alternative | |
team_member_id (anyOf 2) | null | Alternative | |
quota_limit | JSON | Optional | |
quota_limit (anyOf 1) | integer | Alternative | |
quota_limit (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Returns a list of all team-accessible namespaces — response body — namespaces item namespace type
Returns a list of all team-accessible namespaces — response body — namespaces item namespace type
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | Known values: app_folder, shared_folder, team_folder, team_member_folder, team_member_root |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: app_folder |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: shared_folder |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: team_folder |
$ (anyOf 5) | object | Alternative | |
$ (anyOf 5)..tag | string | Required within parent | Must equal: team_member_folder |
$ (anyOf 6) | object | Alternative | |
$ (anyOf 6)..tag | string | Required within parent | Must equal: team_member_root |
$ (anyOf 7) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 7)..tag | string | Required within parent | Pattern: ^(?!(?:app_folder|shared_folder|team_folder|team_member_folder|team_member_root)$) |
Returns information about multiple team members — team members Get Info V2 — response body
Referenced models: Returns information about multiple team members — team members Get Info V2 — response body — members info item
Returns information about multiple team members — team members Get Info V2 — response body — members info item
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | Describes a result obtained for a single user whose id was specified in the parameter of members/get_info:2. |
$ (anyOf 1) | object | Alternative | |
$ (anyOf 1)..tag | string | Required within parent | Must equal: id_not_found |
$ (anyOf 1).id_not_found | string | Required within parent | |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: member_info |
$ (anyOf 2).profile | Model | Required within parent | Expand Updates a team member's profile — team members Set Profile — response body — profile |
$ (anyOf 2).roles | JSON | Optional | |
$ (anyOf 2).roles (anyOf 1) | array | Alternative | |
$ (anyOf 2).roles (anyOf 1)[] | Model | Each item | Expand Get available Team Member Roles for the connected team — response body — roles item |
$ (anyOf 2).roles (anyOf 2) | null | Alternative | |
$ (anyOf 3) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 3)..tag | string | Required within parent | Pattern: ^(?!(?:id_not_found|member_info)$) |
Referenced models: Updates a team member's profile — team members Set Profile — response body — profile, Get available Team Member Roles for the connected team — response body — roles item
Returns information about multiple team members — team members Get Info — request body — body
Referenced models: Sends welcome email to pending team member — request body — body
Returns information about multiple team members — team members Get Info — response body
Referenced models: Returns information about multiple team members — team members Get Info — response body — item
Returns information about multiple team members — team members Get Info — response body — item
Referenced models: Updates a team member's profile — team members Set Profile — response body — role, Updates a team member's profile — team members Set Profile — response body — profile
Returns the member profile of the admin who generated the team access token used to make the call — response body
Referenced models: Updates a team member's profile — team members Set Profile — response body — profile
Returns the space limit configuration of a team folder — response body
Referenced models: Returns the space limit configuration of a team folder — response body — caps type, Returns the space limit configuration of a team folder — response body — notification target
Returns the space limit configuration of a team folder — response body — caps type
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | How a team folder's space limit is enforced. |
$ (anyOf 1) | string | Alternative | Known values: off, soft, hard |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: off |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: soft |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: hard |
$ (anyOf 5) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 5)..tag | string | Required within parent | Pattern: ^(?!(?:off|soft|hard)$) |
Returns the space limit configuration of a team folder — response body — notification target
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | Who receives email notifications when a team folder's usage reaches 80% of its space limit, and when usage reaches or exceeds the limit. These notifications are sent asynchronously, so they can arrive some time after usage crosses a threshold. They are only sent when the caps type is TeamFolderSpaceLimitCapsType.soft or TeamFolderSpaceLimitCapsType.hard. Regardless of this setting, team admins and all members with edit access to the team folder are notified when a space limit is added, changed, or removed. |
$ (anyOf 1) | string | Alternative | Known values: admins, editors, both, silent |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: admins |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: editors |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: both |
$ (anyOf 5) | object | Alternative | |
$ (anyOf 5)..tag | string | Required within parent | Must equal: silent |
$ (anyOf 6) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 6)..tag | string | Required within parent | Pattern: ^(?!(?:admins|editors|both|silent)$) |
Returns the status of an asynchronous job for archiving a team folder — response body
Referenced models: Returns the status of an asynchronous job for archiving a team folder — response body — tag failed failed, Returns the status of an asynchronous job for archiving a team folder — response body — tag complete
Returns the status of an asynchronous job for archiving a team folder — response body — tag complete
Referenced models: Changes an active team folder's name — response body — content sync settings item, Changes an active team folder's name — response body — sync setting, Changes an active team folder's name — response body — status
Returns the status of an asynchronous job for archiving a team folder — response body — tag failed failed
Referenced models: Returns the status of an asynchronous job for archiving a team folder — response body — tag failed failed tag access error access error, Returns the status of an asynchronous job for archiving a team folder — response body — tag failed failed tag status error status error, Returns the status of an asynchronous job for archiving a team folder — response body — tag failed failed tag team shared dropbox error team shared dropbox error
Returns the status of an asynchronous job for archiving a team folder — response body — tag failed failed tag access error access error
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | Known values: invalid_team_folder_id, no_access |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: invalid_team_folder_id |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: no_access |
$ (anyOf 4) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 4)..tag | string | Required within parent | Pattern: ^(?!(?:invalid_team_folder_id|no_access)$) |
Returns the status of an asynchronous job for archiving a team folder — response body — tag failed failed tag status error status error
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | Known values: active, archived, archive_in_progress |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: active |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: archived |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: archive_in_progress |
$ (anyOf 5) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 5)..tag | string | Required within parent | Pattern: ^(?!(?:active|archived|archive_in_progress)$) |
Returns the status of an asynchronous job for archiving a team folder — response body — tag failed failed tag team shared dropbox error team shared dropbox error
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | Known values: disallowed |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: disallowed |
$ (anyOf 3) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 3)..tag | string | Required within parent | Pattern: ^(?!(?:disallowed)$) |
Revoke a device session of a team's member — request body — body
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | |
$ (anyOf 1) | object | Alternative | |
$ (anyOf 1)..tag | string | Required within parent | Must equal: web_session |
$ (anyOf 1).session_id | string | Required within parent | |
$ (anyOf 1).team_member_id | string | Required within parent | |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: desktop_client |
$ (anyOf 2).session_id | string | Required within parent | |
$ (anyOf 2).team_member_id | string | Required within parent | |
$ (anyOf 2).delete_on_unlink | boolean | Optional | |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: mobile_client |
$ (anyOf 3).session_id | string | Required within parent | |
$ (anyOf 3).team_member_id | string | Required within parent | |
Revoke a linked application of the team member — request body — body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
app_id | string | Required within parent | |
team_member_id | string | Required within parent | |
keep_app_folder | boolean | Optional | |
Revoke a list of device sessions of team members — request body — body
Referenced models: Revoke a device session of a team's member — request body — body
Revoke a list of device sessions of team members — response body
Referenced models: Revoke a list of device sessions of team members — response body — revoke devices status item
Revoke a list of device sessions of team members — response body — revoke devices status item
Referenced models: Revoke a list of device sessions of team members — response body — revoke devices status item error type value
Revoke a list of device sessions of team members — response body — revoke devices status item error type value
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | Known values: device_session_not_found, member_not_found |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: device_session_not_found |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: member_not_found |
$ (anyOf 4) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 4)..tag | string | Required within parent | Pattern: ^(?!(?:device_session_not_found|member_not_found)$) |
Revoke a list of linked applications of the team members — request body — body
Referenced models: Revoke a linked application of the team member — request body — body
Revoke a list of linked applications of the team members — response body
Referenced models: Revoke a list of linked applications of the team members — response body — revoke linked app status item
Revoke a list of linked applications of the team members — response body — revoke linked app status item
Referenced models: Revoke a list of linked applications of the team members — response body — revoke linked app status item error type Error returned by linked apps revoke linked app
Revoke a list of linked applications of the team members — response body — revoke linked app status item error type Error returned by linked apps revoke linked app
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | Error returned by linked_apps/revoke_linked_app. |
$ (anyOf 1) | string | Alternative | Known values: app_not_found, member_not_found, app_folder_removal_not_supported |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: app_not_found |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: member_not_found |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: app_folder_removal_not_supported |
$ (anyOf 5) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 5)..tag | string | Required within parent | Pattern: ^(?!(?:app_not_found|member_not_found|app_folder_removal_not_supported)$) |
Sends welcome email to pending team member — request body — body
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | Argument for selecting a single user, either by team_member_id, external_id or email. |
$ (anyOf 1) | object | Alternative | |
$ (anyOf 1)..tag | string | Required within parent | Must equal: team_member_id |
$ (anyOf 1).team_member_id | string | Required within parent | |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: external_id |
$ (anyOf 2).external_id | string | Required within parent | Maximum length: 64 |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: email |
$ (anyOf 3).email | string | Required within parent | Maximum length: 255 Pattern: ^(?:^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$)$ |
Set users custom quota — request body — body
Referenced models: Set users custom quota — request body — body users and quotas item
Set users custom quota — request body — body users and quotas item
Referenced models: Sends welcome email to pending team member — request body — body
Sets an active team folder's status to archived and removes all folder and file members — request body — body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
team_folder_id | string | Required within parent | Pattern: ^(?:[-_0-9a-zA-Z:]+)$ |
force_async_off | boolean | Optional | |
Sets an active team folder's status to archived and removes all folder and file members — response body
Referenced models: Returns the status of an asynchronous job for archiving a team folder — response body — tag complete
Sets the space limit configuration of a team folder, replacing any existing configuration — request body — body
Referenced models: Sets the space limit configuration of a team folder, replacing any existing configuration — request body — body caps type, Sets the space limit configuration of a team folder, replacing any existing configuration — request body — body notification target
Sets the space limit configuration of a team folder, replacing any existing configuration — request body — body caps type
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | How a team folder's space limit is enforced. |
$ (anyOf 1) | string | Alternative | One of: off, soft, hard |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: off |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: soft |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: hard |
$ (anyOf 5) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 5)..tag | string | Required within parent | Pattern: ^(?!(?:off|soft|hard)$) |
Sets the space limit configuration of a team folder, replacing any existing configuration — request body — body notification target
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | Who receives email notifications when a team folder's usage reaches 80% of its space limit, and when usage reaches or exceeds the limit. These notifications are sent asynchronously, so they can arrive some time after usage crosses a threshold. They are only sent when the caps type is TeamFolderSpaceLimitCapsType.soft or TeamFolderSpaceLimitCapsType.hard. Regardless of this setting, team admins and all members with edit access to the team folder are notified when a space limit is added, changed, or removed. |
$ (anyOf 1) | string | Alternative | One of: admins, editors, both, silent |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: admins |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: editors |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: both |
$ (anyOf 5) | object | Alternative | |
$ (anyOf 5)..tag | string | Required within parent | Must equal: silent |
$ (anyOf 6) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 6)..tag | string | Required within parent | Pattern: ^(?!(?:admins|editors|both|silent)$) |
Suspend a member from a team — request body — body
Referenced models: Sends welcome email to pending team member — request body — body
Updates a group's name and or external ID — request body — body
Referenced models: Creates a new, empty group, with a requested name — request body — body group management type The group type determines how a group is managed, Deletes a group — request body — body
Updates a group's name and or external ID — response body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | Full description of a group. |
group_name | string | Required within parent | |
group_id | string | Required within parent | |
group_external_id | JSON | Optional | |
group_external_id (anyOf 1) | string | Alternative | |
group_external_id (anyOf 2) | null | Alternative | |
member_count | JSON | Optional | |
member_count (anyOf 1) | JSON | Alternative | |
member_count (anyOf 1) (anyOf 1) | integer | Alternative | Minimum: 0 |
member_count (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
member_count (anyOf 2) | null | Alternative | |
group_management_type | Model | Required within parent | Expand Updates a group's name and or external ID — response body — group management type |
members | JSON | Optional | |
members (anyOf 1) | array | Alternative | |
members (anyOf 1)[] | Model | Each item | Expand Lists members of a group — response body — members item |
members (anyOf 2) | null | Alternative | |
created | JSON | Required within parent | |
created (anyOf 1) | integer | Alternative | Minimum: 0 |
created (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Updates a group's name and or external ID — response body — group management type, Lists members of a group — response body — members item
Updates a group's name and or external ID — response body — group management type
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | The group type determines how a group is managed. |
$ (anyOf 1) | string | Alternative | Known values: user_managed, company_managed, system_managed |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: user_managed |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: company_managed |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: system_managed |
$ (anyOf 5) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 5)..tag | string | Required within parent | Pattern: ^(?!(?:user_managed|company_managed|system_managed)$) |
Updates a legal hold — request body — body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
id | string | Required within parent | Pattern: ^(?:^pid_dbhid:.+)$ |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | Maximum length: 140 |
name (anyOf 2) | null | Alternative | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Maximum length: 501 |
description (anyOf 2) | null | Alternative | |
members | JSON | Optional | |
members (anyOf 1) | array | Alternative | |
members (anyOf 1)[] | string | Each item | |
members (anyOf 2) | null | Alternative | |
Updates a legal hold — response body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
id | string | Required within parent | Pattern: ^(?:^pid_dbhid:.+)$ |
name | string | Required within parent | Maximum length: 140 |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Maximum length: 501 |
description (anyOf 2) | null | Alternative | |
activation_time | JSON | Optional | |
activation_time (anyOf 1) | string | Alternative | |
activation_time (anyOf 2) | null | Alternative | |
members | Model | Required within parent | Expand Updates a legal hold — response body — members |
status | Model | Required within parent | Expand Updates a legal hold — response body — status |
start_date | string | Required within parent | |
end_date | JSON | Optional | |
end_date (anyOf 1) | string | Alternative | |
end_date (anyOf 2) | null | Alternative | |
Referenced models: Updates a legal hold — response body — status, Updates a legal hold — response body — members
Updates a legal hold — response body — members
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
team_member_ids | array | Required within parent | |
team_member_ids[] | string | Each item | |
permanently_deleted_users | JSON | Required within parent | |
permanently_deleted_users (anyOf 1) | integer | Alternative | Minimum: 0 |
permanently_deleted_users (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Updates a legal hold — response body — status
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | Known values: active, released, activating, updating, exporting, releasing |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: active |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: released |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: activating |
$ (anyOf 5) | object | Alternative | |
$ (anyOf 5)..tag | string | Required within parent | Must equal: updating |
$ (anyOf 6) | object | Alternative | |
$ (anyOf 6)..tag | string | Required within parent | Must equal: exporting |
$ (anyOf 7) | object | Alternative | |
$ (anyOf 7)..tag | string | Required within parent | Must equal: releasing |
$ (anyOf 8) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 8)..tag | string | Required within parent | Pattern: ^(?!(?:active|released|activating|updating|exporting|releasing)$) |
Updates a team member's profile photo — team members Set Profile Photo — request body — body
Referenced models: Sets a user's profile photo — request body — body photo, Sends welcome email to pending team member — request body — body
Updates a team member's profile — team members Set Profile V2 — response body
Referenced models: Updates a team member's profile — team members Set Profile V2 — response body — member info
Updates a team member's profile — team members Set Profile V2 — response body — member info
Referenced models: Updates a team member's profile — team members Set Profile — response body — profile, Get available Team Member Roles for the connected team — response body — roles item
Updates a team member's profile — team members Set Profile — request body — body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | Exactly one of team_member_id, email, or external_id must be provided to identify the user account. At least one of new_email, new_external_id, new_given_name, and/or new_surname must be provided. |
user | Model | Required within parent | Expand Sends welcome email to pending team member — request body — body |
new_email | JSON | Optional | |
new_email (anyOf 1) | string | Alternative | Maximum length: 255 Pattern: ^(?:^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$)$ |
new_email (anyOf 2) | null | Alternative | |
new_external_id | JSON | Optional | |
new_external_id (anyOf 1) | string | Alternative | Maximum length: 64 |
new_external_id (anyOf 2) | null | Alternative | |
new_given_name | JSON | Optional | |
new_given_name (anyOf 1) | string | Alternative | Maximum length: 50 Pattern: ^(?:[^\/:?*<>"|]*)$ |
new_given_name (anyOf 2) | null | Alternative | |
new_surname | JSON | Optional | |
new_surname (anyOf 1) | string | Alternative | Maximum length: 50 Pattern: ^(?:[^\/:?*<>"|]*)$ |
new_surname (anyOf 2) | null | Alternative | |
new_persistent_id | JSON | Optional | |
new_persistent_id (anyOf 1) | string | Alternative | |
new_persistent_id (anyOf 2) | null | Alternative | |
new_is_directory_restricted | JSON | Optional | |
new_is_directory_restricted (anyOf 1) | boolean | Alternative | |
new_is_directory_restricted (anyOf 2) | null | Alternative | |
Referenced models: Sends welcome email to pending team member — request body — body
Updates a team member's profile — team members Set Profile — response body
Referenced models: Updates a team member's profile — team members Set Profile — response body — role, Updates a team member's profile — team members Set Profile — response body — profile
Updates a team member's profile — team members Set Profile — response body — profile
Referenced models: Updates a team member's profile — team members Set Profile — response body — profile secondary emails array item, Updates a team member's profile — team members Set Profile — response body — profile status, Updates a team member's profile — team members Set Profile — response body — profile membership type, Get information about a user's account — response body — name
Updates a team member's profile — team members Set Profile — response body — profile membership type
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | Known values: full, limited |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: full |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: limited |
Updates a team member's profile — team members Set Profile — response body — profile secondary emails array item
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
email | string | Required within parent | Maximum length: 255 Pattern: ^(?:^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$)$ |
is_verified | boolean | Required within parent | |
Updates a team member's profile — team members Set Profile — response body — profile status
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | The user's status as a member of a specific team. |
$ (anyOf 1) | string | Alternative | Known values: active, invited, suspended |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: active |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: invited |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: suspended |
$ (anyOf 5) | object | Alternative | |
$ (anyOf 5)..tag | string | Required within parent | Must equal: removed |
$ (anyOf 5).is_recoverable | boolean | Required within parent | |
$ (anyOf 5).is_disconnected | boolean | Required within parent | |
Updates a team member's profile — team members Set Profile — response body — role
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | Describes which team-related admin permissions a user has. |
$ (anyOf 1) | string | Alternative | Known values: team_admin, user_management_admin, support_admin, member_only |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: team_admin |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: user_management_admin |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: support_admin |
$ (anyOf 5) | object | Alternative | |
$ (anyOf 5)..tag | string | Required within parent | Must equal: member_only |
Updates the sync settings on a team folder or its contents — request body — body
Referenced models: Updates the sync settings on a team folder or its contents — request body — body content sync settings array item, Creates a new, active, team folder with no members — request body — body sync setting value
Updates the sync settings on a team folder or its contents — request body — body content sync settings array item
Referenced models: Creates a new, active, team folder with no members — request body — body sync setting value