← Team operations · All schemas
Add secondary emails to users — request body — body
Referenced models: Resend secondary email verification emails — request body — body emails to resend item
Add secondary emails to users — response body
Referenced models: Add secondary emails to users — response body — results item
Add secondary emails to users — response body — results item
Referenced models: Add secondary emails to users — response body — results item tag success results item, Sends welcome email to pending team member — request body — body
Add secondary emails to users — response body — results item tag success results item
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | Result of trying to add a secondary email to a user. 'success' is the only value indicating that a secondary email was successfully added to a user. The other values explain the type of error that occurred, and include the email for which the error occurred. |
$ (anyOf 1) | object | Alternative | |
$ (anyOf 1)..tag | string | Required within parent | Must equal: success |
$ (anyOf 1).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}$)$ |
$ (anyOf 1).is_verified | boolean | Required within parent | |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: unavailable |
$ (anyOf 2).unavailable | 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}$)$ |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: already_pending |
$ (anyOf 3).already_pending | 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}$)$ |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: already_owned_by_user |
$ (anyOf 4).already_owned_by_user | 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}$)$ |
$ (anyOf 5) | object | Alternative | |
$ (anyOf 5)..tag | string | Required within parent | Must equal: reached_limit |
$ (anyOf 5).reached_limit | 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}$)$ |
$ (anyOf 6) | object | Alternative | |
$ (anyOf 6)..tag | string | Required within parent | Must equal: transient_error |
$ (anyOf 6).transient_error | 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}$)$ |
$ (anyOf 7) | object | Alternative | |
$ (anyOf 7)..tag | string | Required within parent | Must equal: too_many_updates |
$ (anyOf 7).too_many_updates | 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}$)$ |
$ (anyOf 8) | object | Alternative | |
$ (anyOf 8)..tag | string | Required within parent | Must equal: unknown_error |
$ (anyOf 8).unknown_error | 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}$)$ |
$ (anyOf 9) | object | Alternative | |
$ (anyOf 9)..tag | string | Required within parent | Must equal: rate_limited |
$ (anyOf 9).rate_limited | 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}$)$ |
$ (anyOf 10) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 10)..tag | string | Required within parent | Pattern: ^(?!(?:success|unavailable|already_pending|already_owned_by_user|reached_limit|transient_error|too_many_updates|unknown_error|rate_limited)$) |
Add users to member space limits excluded users list — request body — body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | Argument of excluded users update operation. Should include a list of users to add/remove (according to endpoint), Maximum size of the list is 1000 users. |
users | JSON | Optional | |
users (anyOf 1) | array | Alternative | |
users (anyOf 1)[] | Model | Each item | Expand Sends welcome email to pending team member — request body — body |
users (anyOf 2) | null | Alternative | |
Referenced models: Sends welcome email to pending team member — request body — body
Add users to member space limits excluded users list — response body
Referenced models: Add users to member space limits excluded users list — response body — status
Add users to member space limits excluded users list — response body — status
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | Excluded users update operation status. |
$ (anyOf 1) | string | Alternative | Known values: success |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: success |
$ (anyOf 3) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 3)..tag | string | Required within parent | Pattern: ^(?!(?:success)$) |
Changes an active team folder's name — request body — body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
team_folder_id | string | Required within parent | Pattern: ^(?:[-_0-9a-zA-Z:]+)$ |
name | string | Required within parent | |
Changes an active team folder's name — response body
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
Changes an active team folder's name — response body — content sync settings item
Referenced models: Changes an active team folder's name — response body — sync setting
Changes an active team folder's name — response body — status
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | Known values: active, archived, archive_in_progress, inactive |
$ (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 | |
$ (anyOf 5)..tag | string | Required within parent | Must equal: inactive |
$ (anyOf 6) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 6)..tag | string | Required within parent | Pattern: ^(?!(?:active|archived|archive_in_progress|inactive)$) |
Changes an active team folder's name — response body — sync setting
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | Known values: default, not_synced, not_synced_inactive |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: default |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: not_synced |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: not_synced_inactive |
$ (anyOf 5) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 5)..tag | string | Required within parent | Pattern: ^(?!(?:default|not_synced|not_synced_inactive)$) |
Continue listing member space limits excluded users — request body — body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | Excluded users list continue argument. |
cursor | string | Required within parent | |
Continue listing the file metadata that's under the hold — request body — body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
id | string | Required within parent | Pattern: ^(?:^pid_dbhid:.+)$ |
cursor | JSON | Optional | |
cursor (anyOf 1) | string | Alternative | Minimum length: 1 |
cursor (anyOf 2) | null | Alternative | |
Creates a new, active, team folder with no members — request body — body
Referenced models: Creates a new, active, team folder with no members — request body — body sync setting value
Creates a new, active, team folder with no members — request body — body sync setting value
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | One of: default, not_synced |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: default |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: not_synced |
$ (anyOf 4) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 4)..tag | string | Required within parent | Pattern: ^(?!(?:default|not_synced)$) |
Creates a new, empty group, with a requested name — 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
Creates a new, empty group, with a requested name — request body — body group management type The group type determines how a group is managed
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | The group type determines how a group is managed. |
$ (anyOf 1) | string | Alternative | One of: 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)$) |
Creates new legal hold policy — request body — body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
name | string | Required within parent | Maximum length: 140 |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Maximum length: 501 |
description (anyOf 2) | null | Alternative | |
members | array | Required within parent | |
members[] | string | Each item | |
start_date | JSON | Optional | |
start_date (anyOf 1) | string | Alternative | |
start_date (anyOf 2) | null | Alternative | |
end_date | JSON | Optional | |
end_date (anyOf 1) | string | Alternative | |
end_date (anyOf 2) | null | Alternative | |
Delete secondary emails from users Permission : Team member management — request body — body
Referenced models: Resend secondary email verification emails — request body — body emails to resend item
Delete secondary emails from users Permission : Team member management — response body
Referenced models: Delete secondary emails from users Permission : Team member management — response body — results item
Delete secondary emails from users Permission : Team member management — response body — results item
Referenced models: Delete secondary emails from users Permission : Team member management — response body — results item tag success results item, Sends welcome email to pending team member — request body — body
Delete secondary emails from users Permission : Team member management — response body — results item tag success results item
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | Result of trying to delete a secondary email address. 'success' is the only value indicating that a secondary email was successfully deleted. The other values explain the type of error that occurred, and include the email for which the error occurred. |
$ (anyOf 1) | object | Alternative | |
$ (anyOf 1)..tag | string | Required within parent | Must equal: success |
$ (anyOf 1).success | 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}$)$ |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: not_found |
$ (anyOf 2).not_found | 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}$)$ |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: cannot_remove_primary |
$ (anyOf 3).cannot_remove_primary | 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}$)$ |
$ (anyOf 4) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 4)..tag | string | Required within parent | Pattern: ^(?!(?:success|not_found|cannot_remove_primary)$) |
Deletes a group — request body — body
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | Argument for selecting a single group, either by group_id or by external group ID. |
$ (anyOf 1) | object | Alternative | |
$ (anyOf 1)..tag | string | Required within parent | Must equal: group_id |
$ (anyOf 1).group_id | string | Required within parent | |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: group_external_id |
$ (anyOf 2).group_external_id | string | Required within parent | |
Deletes a group — request body — headers Dropbox-API-Path-Root
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | One of: home |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: home |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: root |
$ (anyOf 3).root | string | Required within parent | Pattern: ^(?:[-_0-9a-zA-Z:]+)$ |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: namespace_id |
$ (anyOf 4).namespace_id | string | Required within parent | Pattern: ^(?:[-_0-9a-zA-Z:]+)$ |
$ (anyOf 5) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 5)..tag | string | Required within parent | Pattern: ^(?!(?:home|root|namespace_id)$) |
Deletes a group — response body
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | Result returned by methods that may either launch an asynchronous job or complete synchronously. Upon synchronous completion of the job, no additional information is returned. |
$ (anyOf 1) | string | Alternative | Known values: complete |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: async_job_id |
$ (anyOf 2).async_job_id | string | Required within parent | Minimum length: 1 |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: complete |
Deletes a team member's profile photo — team members Delete Profile Photo — request body — body
Referenced models: Sends welcome email to pending team member — request body — body
Get available Team Member Roles for the connected team — response body
Referenced models: Get available Team Member Roles for the connected team — response body — roles item
Get available Team Member Roles for the connected team — response body — roles item
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | A role which can be attached to a team member. This replaces AdminTier; each AdminTier corresponds to a new TeamMemberRole with a matching name. |
role_id | string | Required within parent | Maximum length: 128 Pattern: ^(?:pid_dbtmr:.*)$ |
name | string | Required within parent | Maximum length: 32 |
description | string | Required within parent | Maximum length: 256 |
Get the values for one or more features — request body — body
Referenced models: Get the values for one or more features — request body — body features item
Get the values for one or more features — request body — body features item
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | A set of features that a Dropbox Business account may support. |
$ (anyOf 1) | string | Alternative | One of: upload_api_rate_limit, has_team_shared_dropbox, has_team_file_events, has_team_selective_sync, has_distinct_member_homes |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: upload_api_rate_limit |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: has_team_shared_dropbox |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: has_team_file_events |
$ (anyOf 5) | object | Alternative | |
$ (anyOf 5)..tag | string | Required within parent | Must equal: has_team_selective_sync |
$ (anyOf 6) | object | Alternative | |
$ (anyOf 6)..tag | string | Required within parent | Must equal: has_distinct_member_homes |
$ (anyOf 7) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 7)..tag | string | Required within parent | Pattern: ^(?!(?:upload_api_rate_limit|has_team_shared_dropbox|has_team_file_events|has_team_selective_sync|has_distinct_member_homes)$) |
Get the values for one or more features — response body
Referenced models: Get the values for one or more features — response body — values item
Get the values for one or more features — response body — values item
Referenced models: Get the values for one or more features — response body — values item tag has distinct member homes has distinct member homes, Get the values for one or more features — response body — values item tag has team file events has team file events, Get the values for one or more features — response body — values item tag has team selective sync has team selective sync, Get the values for one or more features — response body — values item tag has team shared dropbox has team shared dropbox, Get the values for one or more features — response body — values item tag upload api rate limit upload api rate limit
Get the values for one or more features — response body — values item tag has distinct member homes has distinct member homes
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | The value for Feature.has_distinct_member_homes. |
$ (anyOf 1) | object | Alternative | |
$ (anyOf 1)..tag | string | Required within parent | Must equal: has_distinct_member_homes |
$ (anyOf 1).has_distinct_member_homes | boolean | Required within parent | |
$ (anyOf 2) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 2)..tag | string | Required within parent | Pattern: ^(?!(?:has_distinct_member_homes)$) |
Get the values for one or more features — response body — values item tag has team file events has team file events
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | The value for Feature.has_team_file_events. |
$ (anyOf 1) | object | Alternative | |
$ (anyOf 1)..tag | string | Required within parent | Must equal: enabled |
$ (anyOf 1).enabled | boolean | Required within parent | |
$ (anyOf 2) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 2)..tag | string | Required within parent | Pattern: ^(?!(?:enabled)$) |
Get the values for one or more features — response body — values item tag has team selective sync has team selective sync
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | The value for Feature.has_team_selective_sync. |
$ (anyOf 1) | object | Alternative | |
$ (anyOf 1)..tag | string | Required within parent | Must equal: has_team_selective_sync |
$ (anyOf 1).has_team_selective_sync | boolean | Required within parent | |
$ (anyOf 2) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 2)..tag | string | Required within parent | Pattern: ^(?!(?:has_team_selective_sync)$) |
Get the values for one or more features — response body — values item tag has team shared dropbox has team shared dropbox
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | The value for Feature.has_team_shared_dropbox. |
$ (anyOf 1) | object | Alternative | |
$ (anyOf 1)..tag | string | Required within parent | Must equal: has_team_shared_dropbox |
$ (anyOf 1).has_team_shared_dropbox | boolean | Required within parent | |
$ (anyOf 2) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 2)..tag | string | Required within parent | Pattern: ^(?!(?:has_team_shared_dropbox)$) |
Get the values for one or more features — response body — values item tag upload api rate limit upload api rate limit
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | The value for Feature.upload_api_rate_limit. |
$ (anyOf 1) | string | Alternative | Known values: unlimited |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: unlimited |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: limit |
$ (anyOf 3).limit | JSON | Required within parent | |
$ (anyOf 3).limit (anyOf 1) | integer | Alternative | Minimum: 0 |
$ (anyOf 3).limit (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 4) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 4)..tag | string | Required within parent | Pattern: ^(?!(?:unlimited|limit)$) |
Get users custom quota — request body — body
Referenced models: Sends welcome email to pending team member — request body — body
Get users custom quota — response body — item
Referenced models: Get users custom quota — response body — item tag success quota gb value, Sends welcome email to pending team member — request body — body
Get users custom quota — response body — item tag success quota gb value
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | |
$ (anyOf 1) | integer | Alternative | Minimum: 2 |
$ (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Gets a legal hold by Id — request body — body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
id | string | Required within parent | Pattern: ^(?:^pid_dbhid:.+)$ |
Launch a member suspension batch — request body — body
Referenced models: Launch a member suspension batch — request body — body members item
Launch a member suspension batch — request body — body members item
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | One member selected for suspension. The opaque client item ID correlates the eventual report row with the caller's input without sending CSV data. |
client_item_id | string | Required within parent | Maximum length: 128 Minimum length: 1 |
suspend_arg | Model | Required within parent | Expand Suspend a member from a team — request body — body |
Referenced models: Suspend a member from a team — request body — body
Launch a member suspension batch — response body
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | Result returned by methods that launch an asynchronous job. A method who may either launch an asynchronous job, or complete the request synchronously, can use this union by extending it, and adding a 'complete' field with the type of the synchronous response. See LaunchEmptyResult for an example. |
$ (anyOf 1) | object | Alternative | |
$ (anyOf 1)..tag | string | Required within parent | Must equal: async_job_id |
$ (anyOf 1).async_job_id | string | Required within parent | Minimum length: 1 |
List all applications linked to the team members' accounts — request body — body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | Arguments for linked_apps/list_members_linked_apps. |
cursor | JSON | Optional | |
cursor (anyOf 1) | string | Alternative | |
cursor (anyOf 2) | null | Alternative | |
List all applications linked to the team members' accounts — response body
Referenced models: List all applications linked to the team members' accounts — response body — apps item
List all applications linked to the team members' accounts — response body — apps item
Referenced models: List all linked applications of the team member — response body — linked api apps item
List all device sessions of a team — request body — body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
cursor | JSON | Optional | |
cursor (anyOf 1) | string | Alternative | |
cursor (anyOf 2) | null | Alternative | |
include_web_sessions | boolean | Optional | |
include_desktop_clients | boolean | Optional | |
include_mobile_clients | boolean | Optional | |
List all device sessions of a team — response body
Referenced models: List all device sessions of a team — response body — devices item
List all device sessions of a team — response body — devices item
Referenced models: List all device sessions of a team's member — response body — active web sessions array item, List all device sessions of a team's member — response body — desktop client sessions array item, List all device sessions of a team's member — response body — mobile client sessions array item
List all device sessions of a team's member — request body — body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
team_member_id | string | Required within parent | |
include_web_sessions | boolean | Optional | |
include_desktop_clients | boolean | Optional | |
include_mobile_clients | boolean | Optional | |
List all device sessions of a team's member — response body
Referenced models: List all device sessions of a team's member — response body — active web sessions array item, List all device sessions of a team's member — response body — desktop client sessions array item, List all device sessions of a team's member — response body — mobile client sessions array item
List all device sessions of a team's member — response body — active web sessions array item
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | Information on active web sessions. |
session_id | string | Required within parent | |
ip_address | JSON | Optional | |
ip_address (anyOf 1) | string | Alternative | |
ip_address (anyOf 2) | null | Alternative | |
country | JSON | Optional | |
country (anyOf 1) | string | Alternative | |
country (anyOf 2) | null | Alternative | |
created | JSON | Optional | |
created (anyOf 1) | string | Alternative | |
created (anyOf 2) | null | Alternative | |
updated | JSON | Optional | |
updated (anyOf 1) | string | Alternative | |
updated (anyOf 2) | null | Alternative | |
user_agent | string | Required within parent | |
os | string | Required within parent | |
browser | string | Required within parent | |
expires | JSON | Optional | |
expires (anyOf 1) | string | Alternative | |
expires (anyOf 2) | null | Alternative | |
List all device sessions of a team's member — response body — desktop client sessions array item
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | Information about linked Dropbox desktop client sessions. |
session_id | string | Required within parent | |
ip_address | JSON | Optional | |
ip_address (anyOf 1) | string | Alternative | |
ip_address (anyOf 2) | null | Alternative | |
country | JSON | Optional | |
country (anyOf 1) | string | Alternative | |
country (anyOf 2) | null | Alternative | |
created | JSON | Optional | |
created (anyOf 1) | string | Alternative | |
created (anyOf 2) | null | Alternative | |
updated | JSON | Optional | |
updated (anyOf 1) | string | Alternative | |
updated (anyOf 2) | null | Alternative | |
host_name | string | Required within parent | |
client_type | Model | Required within parent | Expand List all device sessions of a team's member — response body — desktop client sessions array item client type |
client_version | string | Required within parent | |
platform | string | Required within parent | |
is_delete_on_unlink_supported | boolean | Required within parent | |
Referenced models: List all device sessions of a team's member — response body — desktop client sessions array item client type
List all device sessions of a team's member — response body — desktop client sessions array item client type
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | Known values: windows, mac, linux |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: windows |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: mac |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: linux |
$ (anyOf 5) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 5)..tag | string | Required within parent | Pattern: ^(?!(?:windows|mac|linux)$) |
List all device sessions of a team's member — response body — mobile client sessions array item
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | Information about linked Dropbox mobile client sessions. |
session_id | string | Required within parent | |
ip_address | JSON | Optional | |
ip_address (anyOf 1) | string | Alternative | |
ip_address (anyOf 2) | null | Alternative | |
country | JSON | Optional | |
country (anyOf 1) | string | Alternative | |
country (anyOf 2) | null | Alternative | |
created | JSON | Optional | |
created (anyOf 1) | string | Alternative | |
created (anyOf 2) | null | Alternative | |
updated | JSON | Optional | |
updated (anyOf 1) | string | Alternative | |
updated (anyOf 2) | null | Alternative | |
device_name | string | Required within parent | |
client_type | Model | Required within parent | Expand List all device sessions of a team's member — response body — mobile client sessions array item client type |
client_version | JSON | Optional | |
client_version (anyOf 1) | string | Alternative | |
client_version (anyOf 2) | null | Alternative | |
os_version | JSON | Optional | |
os_version (anyOf 1) | string | Alternative | |
os_version (anyOf 2) | null | Alternative | |
last_carrier | JSON | Optional | |
last_carrier (anyOf 1) | string | Alternative | |
last_carrier (anyOf 2) | null | Alternative | |
Referenced models: List all device sessions of a team's member — response body — mobile client sessions array item client type
List all device sessions of a team's member — response body — mobile client sessions array item client type
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | Known values: iphone, ipad, android, windows_phone, blackberry |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: iphone |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: ipad |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: android |
$ (anyOf 5) | object | Alternative | |
$ (anyOf 5)..tag | string | Required within parent | Must equal: windows_phone |
$ (anyOf 6) | object | Alternative | |
$ (anyOf 6)..tag | string | Required within parent | Must equal: blackberry |
$ (anyOf 7) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 7)..tag | string | Required within parent | Pattern: ^(?!(?:iphone|ipad|android|windows_phone|blackberry)$) |
List all linked applications of the team member — request body — body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
team_member_id | string | Required within parent | |
List all linked applications of the team member — response body
Referenced models: List all linked applications of the team member — response body — linked api apps item
List all linked applications of the team member — response body — linked api apps item
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | Information on linked third party applications. |
app_id | string | Required within parent | |
app_name | string | Required within parent | |
publisher | JSON | Optional | |
publisher (anyOf 1) | string | Alternative | |
publisher (anyOf 2) | null | Alternative | |
publisher_url | JSON | Optional | |
publisher_url (anyOf 1) | string | Alternative | |
publisher_url (anyOf 2) | null | Alternative | |
linked | JSON | Optional | |
linked (anyOf 1) | string | Alternative | |
linked (anyOf 2) | null | Alternative | |
is_app_folder | boolean | Required within parent | |
List member space limits excluded users — request body — body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | Excluded users list argument. |
limit | integer | Optional | Minimum: 1 Maximum: 1000 |
List member space limits excluded users — response body
Referenced models: List member space limits excluded users — response body — users item
List member space limits excluded users — response body — users item
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
List the file metadata that's under the hold — response body
Referenced models: List the file metadata that's under the hold — response body — entries item
List the file metadata that's under the hold — response body — entries item
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
new_filename | string | Required within parent | |
original_revision_id | string | Required within parent | Minimum length: 9 Pattern: ^(?:[0-9a-f]+)$ |
original_file_path | string | Required within parent | Pattern: ^(?:(/(.|[\r\n])*)?)$ |
server_modified | string | Required within parent | |
author_member_id | string | Required within parent | |
author_member_status | Model | Required within parent | Expand Updates a team member's profile — team members Set Profile — response body — profile status |
author_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}$)$ |
file_type | string | Required within parent | |
size | JSON | Required within parent | |
size (anyOf 1) | integer | Alternative | Minimum: 0 |
size (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
content_hash | string | Required within parent | Maximum length: 64 Minimum length: 64 |
Referenced models: Updates a team member's profile — team members Set Profile — response body — profile status
Lists all team folders — request body — body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
limit | integer | Optional | Minimum: 1 Maximum: 1000 |
Lists all team folders — response body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | Result for team_folder/list and team_folder/list/continue. |
team_folders | array | Required within parent | |
team_folders[] | Model | Each item | Expand Changes an active team folder's name — response body |
cursor | string | Required within parent | |
has_more | boolean | Required within parent | |
Referenced models: Changes an active team folder's name — response body
Lists groups on a team — response body
Referenced models: Lists groups on a team — response body — groups item
Lists groups on a team — response body — groups item
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | Information about 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 |
Referenced models: Updates a group's name and or external ID — response body — group management type
Lists legal holds on a team — request body — body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
include_released | boolean | Optional | |
Lists legal holds on a team — response body
Referenced models: Updates a legal hold — response body
Lists members of a group — request body — body
Referenced models: Deletes a group — request body — body
Lists members of a group — response body
Referenced models: Lists members of a group — response body — members item
Lists members of a group — response body — members item
Referenced models: Lists members of a group — response body — members item access type, List member space limits excluded users — response body — users item
Lists members of a group — response body — members item access type
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | Role of a user in group. |
$ (anyOf 1) | string | Alternative | Known values: member, owner |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: member |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: owner |
Lists members of a team — team members List V2 — response body
Referenced models: Updates a team member's profile — team members Set Profile V2 — response body — member info
Lists members of a team — team members List — request body — body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
limit | integer | Optional | Minimum: 1 Maximum: 1000 |
include_removed | boolean | Optional | |
Lists members of a team — team members List — response body
Referenced models: Updates a team member's profile — team members Set Profile — response body
Moves removed member's files to a different member — request body — body
Referenced models: Sends welcome email to pending team member — request body — body
Once an async job id is returned from members add , use this to poll the status of the asynchronous request — response body
Referenced models: Once an async job id is returned from members add , use this to poll the status of the asynchronous request — response body — tag complete complete item
Once an async job id is returned from members add , use this to poll the status of the asynchronous request — response body — tag complete complete item
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | Describes the result of attempting to add a single user to the team. 'success' is the only value indicating that a user was indeed added to the team - the other values explain the type of failure that occurred, and include the email of the user for which the operation has failed. |
$ (anyOf 1) | object | Alternative | |
$ (anyOf 1)..tag | string | Required within parent | Must equal: team_license_limit |
$ (anyOf 1).team_license_limit | 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}$)$ |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: free_team_member_limit_reached |
$ (anyOf 2).free_team_member_limit_reached | 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}$)$ |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: user_already_on_team |
$ (anyOf 3).user_already_on_team | 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}$)$ |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: user_on_another_team |
$ (anyOf 4).user_on_another_team | 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}$)$ |
$ (anyOf 5) | object | Alternative | |
$ (anyOf 5)..tag | string | Required within parent | Must equal: user_already_paired |
$ (anyOf 5).user_already_paired | 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}$)$ |
$ (anyOf 6) | object | Alternative | |
$ (anyOf 6)..tag | string | Required within parent | Must equal: user_migration_failed |
$ (anyOf 6).user_migration_failed | 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}$)$ |
$ (anyOf 7) | object | Alternative | |
$ (anyOf 7)..tag | string | Required within parent | Must equal: duplicate_external_member_id |
$ (anyOf 7).duplicate_external_member_id | 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}$)$ |
$ (anyOf 8) | object | Alternative | |
$ (anyOf 8)..tag | string | Required within parent | Must equal: duplicate_member_persistent_id |
$ (anyOf 8).duplicate_member_persistent_id | 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}$)$ |
$ (anyOf 9) | object | Alternative | |
$ (anyOf 9)..tag | string | Required within parent | Must equal: persistent_id_disabled |
$ (anyOf 9).persistent_id_disabled | 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}$)$ |
$ (anyOf 10) | object | Alternative | |
$ (anyOf 10)..tag | string | Required within parent | Must equal: user_creation_failed |
$ (anyOf 10).user_creation_failed | 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}$)$ |
$ (anyOf 11) | object | Alternative | |
$ (anyOf 11)..tag | string | Required within parent | Must equal: success |
$ (anyOf 11).profile | Model | Required within parent | Expand Updates a team member's profile — team members Set Profile — response body — profile |
$ (anyOf 11).role | Model | Required within parent | Expand Updates a team member's profile — team members Set Profile — response body — role |
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
Once an async job id is returned from members add:2 , use this to poll the status of the asynchronous request — response body
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | Known values: in_progress |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: in_progress |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: complete |
$ (anyOf 3).complete | array | Required within parent | |
$ (anyOf 3).complete[] | Model | Each item | Expand Once an async job id is returned from members add:2 , use this to poll the status of the asynchronous request — response body — tag complete complete item |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: failed |
$ (anyOf 4).failed | string | Required within parent | |
$ (anyOf 5) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 5)..tag | string | Required within parent | Pattern: ^(?!(?:in_progress|complete|failed)$) |
Referenced models: Once an async job id is returned from members add:2 , use this to poll the status of the asynchronous request — response body — tag complete complete item
Once an async job id is returned from members add:2 , use this to poll the status of the asynchronous request — response body — tag complete complete item
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | Describes the result of attempting to add a single user to the team. 'success' is the only value indicating that a user was indeed added to the team - the other values explain the type of failure that occurred, and include the email of the user for which the operation has failed. |
$ (anyOf 1) | object | Alternative | |
$ (anyOf 1)..tag | string | Required within parent | Must equal: team_license_limit |
$ (anyOf 1).team_license_limit | 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}$)$ |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: free_team_member_limit_reached |
$ (anyOf 2).free_team_member_limit_reached | 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}$)$ |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: user_already_on_team |
$ (anyOf 3).user_already_on_team | 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}$)$ |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: user_on_another_team |
$ (anyOf 4).user_on_another_team | 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}$)$ |
$ (anyOf 5) | object | Alternative | |
$ (anyOf 5)..tag | string | Required within parent | Must equal: user_already_paired |
$ (anyOf 5).user_already_paired | 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}$)$ |
$ (anyOf 6) | object | Alternative | |
$ (anyOf 6)..tag | string | Required within parent | Must equal: user_migration_failed |
$ (anyOf 6).user_migration_failed | 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}$)$ |
$ (anyOf 7) | object | Alternative | |
$ (anyOf 7)..tag | string | Required within parent | Must equal: duplicate_external_member_id |
$ (anyOf 7).duplicate_external_member_id | 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}$)$ |
$ (anyOf 8) | object | Alternative | |
$ (anyOf 8)..tag | string | Required within parent | Must equal: duplicate_member_persistent_id |
$ (anyOf 8).duplicate_member_persistent_id | 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}$)$ |
$ (anyOf 9) | object | Alternative | |
$ (anyOf 9)..tag | string | Required within parent | Must equal: persistent_id_disabled |
$ (anyOf 9).persistent_id_disabled | 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}$)$ |
$ (anyOf 10) | object | Alternative | |
$ (anyOf 10)..tag | string | Required within parent | Must equal: user_creation_failed |
$ (anyOf 10).user_creation_failed | 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}$)$ |
$ (anyOf 11) | object | Alternative | |
$ (anyOf 11)..tag | string | Required within parent | Must equal: success |
$ (anyOf 11).profile | Model | Required within parent | Expand Updates a team member's profile — team members Set Profile — response body — profile |
$ (anyOf 11).roles | JSON | Optional | |
$ (anyOf 11).roles (anyOf 1) | array | Alternative | |
$ (anyOf 11).roles (anyOf 1)[] | Model | Each item | Expand Get available Team Member Roles for the connected team — response body — roles item |
$ (anyOf 11).roles (anyOf 2) | null | Alternative | |
$ (anyOf 12) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 12)..tag | string | Required within parent | Pattern: ^(?!(?:team_license_limit|free_team_member_limit_reached|user_already_on_team|user_on_another_team|user_already_paired|user_migration_failed|duplicate_external_member_id|duplicate_member_persistent_id|persistent_id_disabled|user_creation_failed|success)$) |
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
Once an async job id is returned from members remove , use this to poll the status of the asynchronous request — response body
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | Result returned by methods that poll for the status of an asynchronous job. Upon completion of the job, no additional information is returned. |
$ (anyOf 1) | string | Alternative | Known values: in_progress, complete |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: in_progress |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: complete |
Permanently delete the files of a user who has been removed from the team — request body — body
Referenced models: Sends welcome email to pending team member — request body — body
Permanently deletes an archived team folder — request body — body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
team_folder_id | string | Required within parent | Pattern: ^(?:[-_0-9a-zA-Z:]+)$ |
Poll a previously launched member suspension batch job — response body
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | Coarse job state. Live row progress and report contents are intentionally omitted; the authorized team admin who initiated the batch receives row details in the terminal email report. |
$ (anyOf 1) | string | Alternative | Known values: in_progress |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: in_progress |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: complete |
$ (anyOf 3).requested | JSON | Required within parent | |
$ (anyOf 3).requested (anyOf 1) | integer | Alternative | |
$ (anyOf 3).requested (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 3).suspended | JSON | Required within parent | |
$ (anyOf 3).suspended (anyOf 1) | integer | Alternative | |
$ (anyOf 3).suspended (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 3).failed | JSON | Required within parent | |
$ (anyOf 3).failed (anyOf 1) | integer | Alternative | |
$ (anyOf 3).failed (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 3).unknown | JSON | Required within parent | |
$ (anyOf 3).unknown (anyOf 1) | integer | Alternative | |
$ (anyOf 3).unknown (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 3).report_delivery | Model | Required within parent | Expand Poll a previously launched member suspension batch job — response body — tag complete report delivery |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: failed |
$ (anyOf 4).failed | Model | Required within parent | Expand Poll a previously launched member suspension batch job — response body — tag failed failed |
$ (anyOf 5) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 5)..tag | string | Required within parent | Pattern: ^(?!(?:in_progress|complete|failed)$) |
Referenced models: Poll a previously launched member suspension batch job — response body — tag complete report delivery, Poll a previously launched member suspension batch job — response body — tag failed failed
Poll a previously launched member suspension batch job — response body — tag complete report delivery
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | Known values: members_suspend_batch_report_delivery_status_unspecified, members_suspend_batch_report_delivery_status_pending, members_suspend_batch_report_delivery_status_delivered, members_suspend_batch_report_delivery_status_failed |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: members_suspend_batch_report_delivery_status_unspecified |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: members_suspend_batch_report_delivery_status_pending |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: members_suspend_batch_report_delivery_status_delivered |
$ (anyOf 5) | object | Alternative | |
$ (anyOf 5)..tag | string | Required within parent | Must equal: members_suspend_batch_report_delivery_status_failed |
$ (anyOf 6) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 6)..tag | string | Required within parent | Pattern: ^(?!(?:members_suspend_batch_report_delivery_status_unspecified|members_suspend_batch_report_delivery_status_pending|members_suspend_batch_report_delivery_status_delivered|members_suspend_batch_report_delivery_status_failed)$) |
Poll a previously launched member suspension batch job — response body — tag failed failed
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | Known values: unusable_result |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: unusable_result |
$ (anyOf 3) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 3)..tag | string | Required within parent | Pattern: ^(?!(?:unusable_result)$) |
Recover a deleted member — request body — body
Referenced models: Sends welcome email to pending team member — request body — body
Remove users custom quota — response body — item
Referenced models: Sends welcome email to pending team member — request body — body
Removes a member from a team — request body — body
Referenced models: Sends welcome email to pending team member — request body — body
Removes members from a group — request body — body
Referenced models: Sends welcome email to pending team member — request body — body, Deletes a group — request body — body
Removes members from a group — response body
Referenced models: Updates a group's name and or external ID — response body
Resend secondary email verification emails — request body — body
Referenced models: Resend secondary email verification emails — request body — body emails to resend item
Resend secondary email verification emails — request body — body emails to resend item
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | User and a list of secondary emails. |
user | Model | Required within parent | Expand Sends welcome email to pending team member — request body — body |
secondary_emails | array | Required within parent | |
secondary_emails[] | string | Each item | Maximum length: 255 Pattern: ^(?:^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$)$ |
Referenced models: Sends welcome email to pending team member — request body — body
Resend secondary email verification emails — response body
Referenced models: Resend secondary email verification emails — response body — results item
Resend secondary email verification emails — response body — results item
Referenced models: Resend secondary email verification emails — response body — results item tag success results item, Sends welcome email to pending team member — request body — body
Resend secondary email verification emails — response body — results item tag success results item
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | Result of trying to resend verification email to a secondary email address. 'success' is the only value indicating that a verification email was successfully sent. The other values explain the type of error that occurred, and include the email for which the error occurred. |
$ (anyOf 1) | object | Alternative | |
$ (anyOf 1)..tag | string | Required within parent | Must equal: success |
$ (anyOf 1).success | 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}$)$ |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: not_pending |
$ (anyOf 2).not_pending | 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}$)$ |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: rate_limited |
$ (anyOf 3).rate_limited | 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}$)$ |
$ (anyOf 4) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 4)..tag | string | Required within parent | Pattern: ^(?!(?:success|not_pending|rate_limited)$) |
Retrieves information about a team — response body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
name | string | Required within parent | |
team_id | string | Required within parent | |
num_licensed_users | JSON | Required within parent | |
num_licensed_users (anyOf 1) | integer | Alternative | Minimum: 0 |
num_licensed_users (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
num_provisioned_users | JSON | Required within parent | |
num_provisioned_users (anyOf 1) | integer | Alternative | Minimum: 0 |
num_provisioned_users (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
num_used_licenses | JSON | Optional | |
num_used_licenses (anyOf 1) | integer | Alternative | Minimum: 0 |
num_used_licenses (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
policies | Model | Required within parent | Expand Retrieves information about a team — response body — policies |
Referenced models: Retrieves information about a team — response body — policies
Retrieves information about a team — response body — policies
Referenced models: Retrieves information about a team — response body — policies office addin, Retrieves information about a team — response body — policies emm state, Retrieves information about a team — response body — policies sharing, Retrieves information about a team — response body — policies top level content policy
Retrieves information about a team — response body — policies emm state
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | Known values: disabled, optional, required |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: disabled |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: optional |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: required |
$ (anyOf 5) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 5)..tag | string | Required within parent | Pattern: ^(?!(?:disabled|optional|required)$) |
Retrieves information about a team — response body — policies office addin
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | Known values: disabled, enabled |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: disabled |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: enabled |
$ (anyOf 4) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 4)..tag | string | Required within parent | Pattern: ^(?!(?:disabled|enabled)$) |
Retrieves information about a team — response body — policies sharing
Referenced models: Retrieves information about a team — response body — policies sharing default link expiration days policy, Retrieves information about a team — response body — policies sharing enforce link password policy, Retrieves information about a team — response body — policies sharing group creation policy, Retrieves information about a team — response body — policies sharing shared folder link restriction policy, Retrieves information about a team — response body — policies sharing shared folder join policy, Retrieves information about a team — response body — policies sharing shared folder member policy, Retrieves information about a team — response body — policies sharing shared link create policy, Retrieves information about a team — response body — policies sharing shared link default permissions policy
Retrieves information about a team — response body — policies sharing default link expiration days policy
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | Policy governing default expiration date for new links shared outside the team. |
$ (anyOf 1) | string | Alternative | Known values: none, day_1, day_3, day_7, day_30, day_90, day_180, year_1 |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: none |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: day_1 |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: day_3 |
$ (anyOf 5) | object | Alternative | |
$ (anyOf 5)..tag | string | Required within parent | Must equal: day_7 |
$ (anyOf 6) | object | Alternative | |
$ (anyOf 6)..tag | string | Required within parent | Must equal: day_30 |
$ (anyOf 7) | object | Alternative | |
$ (anyOf 7)..tag | string | Required within parent | Must equal: day_90 |
$ (anyOf 8) | object | Alternative | |
$ (anyOf 8)..tag | string | Required within parent | Must equal: day_180 |
$ (anyOf 9) | object | Alternative | |
$ (anyOf 9)..tag | string | Required within parent | Must equal: year_1 |
$ (anyOf 10) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 10)..tag | string | Required within parent | Pattern: ^(?!(?:none|day_1|day_3|day_7|day_30|day_90|day_180|year_1)$) |
Retrieves information about a team — response body — policies sharing enforce link password policy
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | Policy governing whether new links shared outside the team require passwords. |
$ (anyOf 1) | string | Alternative | Known values: optional, required |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: optional |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: required |
$ (anyOf 4) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 4)..tag | string | Required within parent | Pattern: ^(?!(?:optional|required)$) |
Retrieves information about a team — response body — policies sharing group creation policy
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | Known values: admins_and_members, admins_only |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: admins_and_members |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: admins_only |
Retrieves information about a team — response body — policies sharing shared folder join policy
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | Policy governing which shared folders a team member can join. |
$ (anyOf 1) | string | Alternative | Known values: from_team_only, from_anyone |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: from_team_only |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: from_anyone |
$ (anyOf 4) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 4)..tag | string | Required within parent | Pattern: ^(?!(?:from_team_only|from_anyone)$) |
Retrieves information about a team — response body — policies sharing shared folder link restriction policy
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | Policy governing whether shared folder membership is required to access shared links. |
$ (anyOf 1) | string | Alternative | Known values: members, anyone |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: members |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: anyone |
$ (anyOf 4) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 4)..tag | string | Required within parent | Pattern: ^(?!(?:members|anyone)$) |
Retrieves information about a team — response body — policies sharing shared folder member policy
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | Policy governing who can be a member of a folder shared by a team member. |
$ (anyOf 1) | string | Alternative | Known values: team, anyone, team_and_approved |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: team |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: anyone |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: team_and_approved |
$ (anyOf 5) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 5)..tag | string | Required within parent | Pattern: ^(?!(?:team|anyone|team_and_approved)$) |
Retrieves information about a team — response body — policies sharing shared link create policy
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | Policy governing the visibility of shared links. This policy can apply to newly created shared links, or all shared links. |
$ (anyOf 1) | string | Alternative | Known values: default_public, default_team_only, team_only, default_no_one |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: default_public |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: default_team_only |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: team_only |
$ (anyOf 5) | object | Alternative | |
$ (anyOf 5)..tag | string | Required within parent | Must equal: default_no_one |
$ (anyOf 6) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 6)..tag | string | Required within parent | Pattern: ^(?!(?:default_public|default_team_only|team_only|default_no_one)$) |
Retrieves information about a team — response body — policies sharing shared link default permissions policy
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | Known values: default, edit, view |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: default |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: edit |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: view |
$ (anyOf 5) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 5)..tag | string | Required within parent | Pattern: ^(?!(?:default|edit|view)$) |
Retrieves information about a team — response body — policies top level content policy
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | Known values: admin_only, everyone |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: admin_only |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: everyone |
$ (anyOf 4) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 4)..tag | string | Required within parent | Pattern: ^(?!(?:admin_only|everyone)$) |
Retrieves information about one or more groups — request body — body
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | Argument for selecting a list of groups, either by group_ids, or external group IDs. |
$ (anyOf 1) | object | Alternative | |
$ (anyOf 1)..tag | string | Required within parent | Must equal: group_ids |
$ (anyOf 1).group_ids | array | Required within parent | |
$ (anyOf 1).group_ids[] | string | Each item | |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: group_external_ids |
$ (anyOf 2).group_external_ids | array | Required within parent | |
$ (anyOf 2).group_external_ids[] | string | Each item | |
Retrieves information about one or more groups — response body
Referenced models: Retrieves information about one or more groups — response body — item
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