Skip to content

Dropbox: Team schemas (part 2)

59 Dropbox schemas with complete fields and constraints.

← Team operations · All schemas

Retrieves information about one or more groups — response body — item

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)objectAlternative
$ (anyOf 1)..tagstringRequired within parentMust equal: id_not_found
$ (anyOf 1).id_not_foundstringRequired within parent
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: group_info
$ (anyOf 2).group_namestringRequired within parent
$ (anyOf 2).group_idstringRequired within parent
$ (anyOf 2).group_external_idJSONOptional
$ (anyOf 2).group_external_id (anyOf 1)stringAlternative
$ (anyOf 2).group_external_id (anyOf 2)nullAlternative
$ (anyOf 2).member_countJSONOptional
$ (anyOf 2).member_count (anyOf 1)JSONAlternative
$ (anyOf 2).member_count (anyOf 1) (anyOf 1)integerAlternativeMinimum: 0
$ (anyOf 2).member_count (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 2).member_count (anyOf 2)nullAlternative
$ (anyOf 2).group_management_typeModelRequired within parentExpand Updates a group's name and or external ID — response body — group management type
$ (anyOf 2).membersJSONOptional
$ (anyOf 2).members (anyOf 1)arrayAlternative
$ (anyOf 2).members (anyOf 1)[]ModelEach itemExpand Lists members of a group — response body — members item
$ (anyOf 2).members (anyOf 2)nullAlternative
$ (anyOf 2).createdJSONRequired within parent
$ (anyOf 2).created (anyOf 1)integerAlternativeMinimum: 0
$ (anyOf 2).created (anyOf 2)stringAlternativePattern: ^-?[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

FieldTypePresenceDescription and constraints
$objectRoot
team_folder_idsarrayRequired within parentMinimum items: 1
team_folder_ids[]stringEach itemPattern: ^(?:[-_0-9a-zA-Z:]+)$

Retrieves metadata for team folders — response body — item

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)objectAlternative
$ (anyOf 1)..tagstringRequired within parentMust equal: id_not_found
$ (anyOf 1).id_not_foundstringRequired within parent
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: team_folder_metadata
$ (anyOf 2).team_folder_idstringRequired within parentPattern: ^(?:[-_0-9a-zA-Z:]+)$
$ (anyOf 2).namestringRequired within parent
$ (anyOf 2).statusModelRequired within parentExpand Changes an active team folder's name — response body — status
$ (anyOf 2).is_team_shared_dropboxbooleanRequired within parent
$ (anyOf 2).sync_settingModelRequired within parentExpand Changes an active team folder's name — response body — sync setting
$ (anyOf 2).content_sync_settingsarrayRequired within parent
$ (anyOf 2).content_sync_settings[]ModelEach itemExpand Changes an active team folder's name — response body — content sync settings item
$ (anyOf 2).quota_limitJSONOptional
$ (anyOf 2).quota_limit (anyOf 1)integerAlternative
$ (anyOf 2).quota_limit (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

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

FieldTypePresenceDescription and constraints
$objectRootResult for namespaces/list.
namespacesarrayRequired within parent
namespaces[]ModelEach itemExpand Returns a list of all team-accessible namespaces — response body — namespaces item
cursorstringRequired within parent
has_morebooleanRequired within parent

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

FieldTypePresenceDescription and constraints
$objectRootProperties of a namespace.
namestringRequired within parent
namespace_idstringRequired within parentPattern: ^(?:[-_0-9a-zA-Z:]+)$
namespace_typeModelRequired within parentExpand Returns a list of all team-accessible namespaces — response body — namespaces item namespace type
team_member_idJSONOptional
team_member_id (anyOf 1)stringAlternative
team_member_id (anyOf 2)nullAlternative
quota_limitJSONOptional
quota_limit (anyOf 1)integerAlternative
quota_limit (anyOf 2)stringAlternativePattern: ^-?[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

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)stringAlternativeKnown values: app_folder, shared_folder, team_folder, team_member_folder, team_member_root
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: app_folder
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: shared_folder
$ (anyOf 4)objectAlternative
$ (anyOf 4)..tagstringRequired within parentMust equal: team_folder
$ (anyOf 5)objectAlternative
$ (anyOf 5)..tagstringRequired within parentMust equal: team_member_folder
$ (anyOf 6)objectAlternative
$ (anyOf 6)..tagstringRequired within parentMust equal: team_member_root
$ (anyOf 7)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 7)..tagstringRequired within parentPattern: ^(?!(?: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

FieldTypePresenceDescription and constraints
$objectRoot
members_infoarrayRequired within parent
members_info[]ModelEach itemExpand Returns information about multiple team members — team members Get Info V2 — response body — members info item

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

FieldTypePresenceDescription and constraints
$JSONRootDescribes a result obtained for a single user whose id was specified in the parameter of members/get_info:2.
$ (anyOf 1)objectAlternative
$ (anyOf 1)..tagstringRequired within parentMust equal: id_not_found
$ (anyOf 1).id_not_foundstringRequired within parent
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: member_info
$ (anyOf 2).profileModelRequired within parentExpand Updates a team member's profile — team members Set Profile — response body — profile
$ (anyOf 2).rolesJSONOptional
$ (anyOf 2).roles (anyOf 1)arrayAlternative
$ (anyOf 2).roles (anyOf 1)[]ModelEach itemExpand Get available Team Member Roles for the connected team — response body — roles item
$ (anyOf 2).roles (anyOf 2)nullAlternative
$ (anyOf 3)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 3)..tagstringRequired within parentPattern: ^(?!(?: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

FieldTypePresenceDescription and constraints
$objectRoot
membersarrayRequired within parent
members[]ModelEach itemExpand Sends welcome email to pending team member — 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

FieldTypePresenceDescription and constraints
$arrayRoot
$[]ModelEach itemExpand Returns information about multiple team members — team members Get Info — response body — item

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

FieldTypePresenceDescription and constraints
$JSONRootDescribes a result obtained for a single user whose id was specified in the parameter of members/get_info.
$ (anyOf 1)objectAlternative
$ (anyOf 1)..tagstringRequired within parentMust equal: id_not_found
$ (anyOf 1).id_not_foundstringRequired within parent
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: member_info
$ (anyOf 2).profileModelRequired within parentExpand Updates a team member's profile — team members Set Profile — response body — profile
$ (anyOf 2).roleModelRequired within parentExpand 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

Returns the member profile of the admin who generated the team access token used to make the call — response body

FieldTypePresenceDescription and constraints
$objectRootResults for token/get_authenticated_admin.
admin_profileModelRequired within parentExpand 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

Returns the space limit configuration of a team folder — response body

FieldTypePresenceDescription and constraints
$objectRootThe space limit configuration of a team folder. If no space limit has ever been set for the team folder, space_limit_bytes is 0, caps_type is TeamFolderSpaceLimitCapsType.off, and notification_target is TeamFolderSpaceLimitNotificationTarget.admins.
space_limit_bytesJSONOptional
space_limit_bytes (anyOf 1)integerAlternativeMinimum: 0
space_limit_bytes (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
caps_typeModelRequired within parentExpand Returns the space limit configuration of a team folder — response body — caps type
notification_targetModelRequired within parentExpand Returns the space limit configuration of a team folder — response body — notification target

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

FieldTypePresenceDescription and constraints
$JSONRootHow a team folder's space limit is enforced.
$ (anyOf 1)stringAlternativeKnown values: off, soft, hard
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: off
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: soft
$ (anyOf 4)objectAlternative
$ (anyOf 4)..tagstringRequired within parentMust equal: hard
$ (anyOf 5)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 5)..tagstringRequired within parentPattern: ^(?!(?:off|soft|hard)$)

Returns the space limit configuration of a team folder — response body — notification target

FieldTypePresenceDescription and constraints
$JSONRootWho 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)stringAlternativeKnown values: admins, editors, both, silent
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: admins
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: editors
$ (anyOf 4)objectAlternative
$ (anyOf 4)..tagstringRequired within parentMust equal: both
$ (anyOf 5)objectAlternative
$ (anyOf 5)..tagstringRequired within parentMust equal: silent
$ (anyOf 6)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 6)..tagstringRequired within parentPattern: ^(?!(?:admins|editors|both|silent)$)

Returns the status of an asynchronous job for archiving a team folder — response body

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)stringAlternativeKnown values: in_progress
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: in_progress
$ (anyOf 3)ModelAlternativeExpand Returns the status of an asynchronous job for archiving a team folder — response body — tag complete
$ (anyOf 4)objectAlternative
$ (anyOf 4)..tagstringRequired within parentMust equal: failed
$ (anyOf 4).failedModelRequired within parentExpand 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, 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

FieldTypePresenceDescription and constraints
$objectRoot
.tagstringRequired within parentMust equal: complete
team_folder_idstringRequired within parentPattern: ^(?:[-_0-9a-zA-Z:]+)$
namestringRequired within parent
statusModelRequired within parentExpand Changes an active team folder's name — response body — status
is_team_shared_dropboxbooleanRequired within parent
sync_settingModelRequired within parentExpand Changes an active team folder's name — response body — sync setting
content_sync_settingsarrayRequired within parent
content_sync_settings[]ModelEach itemExpand Changes an active team folder's name — response body — content sync settings item
quota_limitJSONOptional
quota_limit (anyOf 1)integerAlternative
quota_limit (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

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

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)objectAlternative
$ (anyOf 1)..tagstringRequired within parentMust equal: access_error
$ (anyOf 1).access_errorModelRequired within parentExpand Returns the status of an asynchronous job for archiving a team folder — response body — tag failed failed tag access error access error
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: status_error
$ (anyOf 2).status_errorModelRequired within parentExpand Returns the status of an asynchronous job for archiving a team folder — response body — tag failed failed tag status error status error
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: team_shared_dropbox_error
$ (anyOf 3).team_shared_dropbox_errorModelRequired within parentExpand 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
$ (anyOf 4)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 4)..tagstringRequired within parentPattern: ^(?!(?:access_error|status_error|team_shared_dropbox_error)$)

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

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)stringAlternativeKnown values: invalid_team_folder_id, no_access
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: invalid_team_folder_id
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: no_access
$ (anyOf 4)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 4)..tagstringRequired within parentPattern: ^(?!(?: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

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)stringAlternativeKnown values: active, archived, archive_in_progress
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: active
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: archived
$ (anyOf 4)objectAlternative
$ (anyOf 4)..tagstringRequired within parentMust equal: archive_in_progress
$ (anyOf 5)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 5)..tagstringRequired within parentPattern: ^(?!(?: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

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)stringAlternativeKnown values: disallowed
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: disallowed
$ (anyOf 3)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 3)..tagstringRequired within parentPattern: ^(?!(?:disallowed)$)

Revoke a device session of a team's member — request body — body

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)objectAlternative
$ (anyOf 1)..tagstringRequired within parentMust equal: web_session
$ (anyOf 1).session_idstringRequired within parent
$ (anyOf 1).team_member_idstringRequired within parent
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: desktop_client
$ (anyOf 2).session_idstringRequired within parent
$ (anyOf 2).team_member_idstringRequired within parent
$ (anyOf 2).delete_on_unlinkbooleanOptional
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: mobile_client
$ (anyOf 3).session_idstringRequired within parent
$ (anyOf 3).team_member_idstringRequired within parent

Revoke a linked application of the team member — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
app_idstringRequired within parent
team_member_idstringRequired within parent
keep_app_folderbooleanOptional

Revoke a list of device sessions of team members — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
revoke_devicesarrayRequired within parent
revoke_devices[]ModelEach itemExpand Revoke a device session of a team's member — 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

FieldTypePresenceDescription and constraints
$objectRoot
revoke_devices_statusarrayRequired within parent
revoke_devices_status[]ModelEach itemExpand 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

Revoke a list of device sessions of team members — response body — revoke devices status item

FieldTypePresenceDescription and constraints
$objectRoot
successbooleanRequired within parent
error_typeJSONOptional
error_type (anyOf 1)ModelAlternativeExpand Revoke a list of device sessions of team members — response body — revoke devices status item error type value
error_type (anyOf 2)nullAlternative

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

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)stringAlternativeKnown values: device_session_not_found, member_not_found
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: device_session_not_found
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: member_not_found
$ (anyOf 4)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 4)..tagstringRequired within parentPattern: ^(?!(?:device_session_not_found|member_not_found)$)

Revoke a list of linked applications of the team members — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
revoke_linked_apparrayRequired within parent
revoke_linked_app[]ModelEach itemExpand Revoke a linked application of the team member — 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

FieldTypePresenceDescription and constraints
$objectRoot
revoke_linked_app_statusarrayRequired within parent
revoke_linked_app_status[]ModelEach itemExpand 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

Revoke a list of linked applications of the team members — response body — revoke linked app status item

FieldTypePresenceDescription and constraints
$objectRoot
successbooleanRequired within parent
error_typeJSONOptional
error_type (anyOf 1)ModelAlternativeExpand 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
error_type (anyOf 2)nullAlternative

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

FieldTypePresenceDescription and constraints
$JSONRootError returned by linked_apps/revoke_linked_app.
$ (anyOf 1)stringAlternativeKnown values: app_not_found, member_not_found, app_folder_removal_not_supported
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: app_not_found
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: member_not_found
$ (anyOf 4)objectAlternative
$ (anyOf 4)..tagstringRequired within parentMust equal: app_folder_removal_not_supported
$ (anyOf 5)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 5)..tagstringRequired within parentPattern: ^(?!(?:app_not_found|member_not_found|app_folder_removal_not_supported)$)

Sends welcome email to pending team member — request body — body

FieldTypePresenceDescription and constraints
$JSONRootArgument for selecting a single user, either by team_member_id, external_id or email.
$ (anyOf 1)objectAlternative
$ (anyOf 1)..tagstringRequired within parentMust equal: team_member_id
$ (anyOf 1).team_member_idstringRequired within parent
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: external_id
$ (anyOf 2).external_idstringRequired within parentMaximum length: 64
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: email
$ (anyOf 3).emailstringRequired within parentMaximum 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

FieldTypePresenceDescription and constraints
$objectRoot
users_and_quotasarrayRequired within parent
users_and_quotas[]ModelEach itemExpand Set users custom quota — request body — body users and quotas item

Referenced models: Set users custom quota — request body — body users and quotas item

Set users custom quota — request body — body users and quotas item

FieldTypePresenceDescription and constraints
$objectRootUser and their required custom quota in GB (1 TB = 1024 GB).
userModelRequired within parentExpand Sends welcome email to pending team member — request body — body
quota_gbintegerRequired within parentMinimum: 2

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

FieldTypePresenceDescription and constraints
$objectRoot
team_folder_idstringRequired within parentPattern: ^(?:[-_0-9a-zA-Z:]+)$
force_async_offbooleanOptional

Sets an active team folder's status to archived and removes all folder and file members — response body

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)objectAlternative
$ (anyOf 1)..tagstringRequired within parentMust equal: async_job_id
$ (anyOf 1).async_job_idstringRequired within parentMinimum length: 1
$ (anyOf 2)ModelAlternativeExpand Returns the status of an asynchronous job for archiving a team folder — response body — tag complete

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

FieldTypePresenceDescription and constraints
$objectRootArguments for team_folder/space_limit/set.
team_folder_idstringRequired within parentPattern: ^(?:[-_0-9a-zA-Z:]+)$
space_limit_bytesintegerRequired within parentMinimum: 0
caps_typeModelRequired within parentExpand Sets the space limit configuration of a team folder, replacing any existing configuration — request body — body caps type
notification_targetModelRequired within parentExpand Sets the space limit configuration of a team folder, replacing any existing configuration — request body — body notification target

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

FieldTypePresenceDescription and constraints
$JSONRootHow a team folder's space limit is enforced.
$ (anyOf 1)stringAlternativeOne of: off, soft, hard
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: off
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: soft
$ (anyOf 4)objectAlternative
$ (anyOf 4)..tagstringRequired within parentMust equal: hard
$ (anyOf 5)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 5)..tagstringRequired within parentPattern: ^(?!(?:off|soft|hard)$)

Sets the space limit configuration of a team folder, replacing any existing configuration — request body — body notification target

FieldTypePresenceDescription and constraints
$JSONRootWho 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)stringAlternativeOne of: admins, editors, both, silent
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: admins
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: editors
$ (anyOf 4)objectAlternative
$ (anyOf 4)..tagstringRequired within parentMust equal: both
$ (anyOf 5)objectAlternative
$ (anyOf 5)..tagstringRequired within parentMust equal: silent
$ (anyOf 6)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 6)..tagstringRequired within parentPattern: ^(?!(?:admins|editors|both|silent)$)

Suspend a member from a team — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
userModelRequired within parentExpand Sends welcome email to pending team member — request body — body
wipe_databooleanOptional

Referenced models: Sends welcome email to pending team member — request body — body

Updates a group's name and or external ID — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
return_membersbooleanOptional
groupModelRequired within parentExpand Deletes a group — request body — body
new_group_nameJSONOptional
new_group_name (anyOf 1)stringAlternative
new_group_name (anyOf 2)nullAlternative
new_group_external_idJSONOptional
new_group_external_id (anyOf 1)stringAlternative
new_group_external_id (anyOf 2)nullAlternative
new_group_management_typeJSONOptional
new_group_management_type (anyOf 1)ModelAlternativeExpand Creates a new, empty group, with a requested name — request body — body group management type The group type determines how a group is managed
new_group_management_type (anyOf 2)nullAlternative

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

FieldTypePresenceDescription and constraints
$objectRootFull description of a group.
group_namestringRequired within parent
group_idstringRequired within parent
group_external_idJSONOptional
group_external_id (anyOf 1)stringAlternative
group_external_id (anyOf 2)nullAlternative
member_countJSONOptional
member_count (anyOf 1)JSONAlternative
member_count (anyOf 1) (anyOf 1)integerAlternativeMinimum: 0
member_count (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
member_count (anyOf 2)nullAlternative
group_management_typeModelRequired within parentExpand Updates a group's name and or external ID — response body — group management type
membersJSONOptional
members (anyOf 1)arrayAlternative
members (anyOf 1)[]ModelEach itemExpand Lists members of a group — response body — members item
members (anyOf 2)nullAlternative
createdJSONRequired within parent
created (anyOf 1)integerAlternativeMinimum: 0
created (anyOf 2)stringAlternativePattern: ^-?[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

FieldTypePresenceDescription and constraints
$JSONRootThe group type determines how a group is managed.
$ (anyOf 1)stringAlternativeKnown values: user_managed, company_managed, system_managed
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: user_managed
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: company_managed
$ (anyOf 4)objectAlternative
$ (anyOf 4)..tagstringRequired within parentMust equal: system_managed
$ (anyOf 5)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 5)..tagstringRequired within parentPattern: ^(?!(?:user_managed|company_managed|system_managed)$)

Updates a legal hold — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentPattern: ^(?:^pid_dbhid:.+)$
nameJSONOptional
name (anyOf 1)stringAlternativeMaximum length: 140
name (anyOf 2)nullAlternative
descriptionJSONOptional
description (anyOf 1)stringAlternativeMaximum length: 501
description (anyOf 2)nullAlternative
membersJSONOptional
members (anyOf 1)arrayAlternative
members (anyOf 1)[]stringEach item
members (anyOf 2)nullAlternative

Updates a legal hold — response body

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentPattern: ^(?:^pid_dbhid:.+)$
namestringRequired within parentMaximum length: 140
descriptionJSONOptional
description (anyOf 1)stringAlternativeMaximum length: 501
description (anyOf 2)nullAlternative
activation_timeJSONOptional
activation_time (anyOf 1)stringAlternative
activation_time (anyOf 2)nullAlternative
membersModelRequired within parentExpand Updates a legal hold — response body — members
statusModelRequired within parentExpand Updates a legal hold — response body — status
start_datestringRequired within parent
end_dateJSONOptional
end_date (anyOf 1)stringAlternative
end_date (anyOf 2)nullAlternative

Referenced models: Updates a legal hold — response body — status, Updates a legal hold — response body — members

Updates a legal hold — response body — members

FieldTypePresenceDescription and constraints
$objectRoot
team_member_idsarrayRequired within parent
team_member_ids[]stringEach item
permanently_deleted_usersJSONRequired within parent
permanently_deleted_users (anyOf 1)integerAlternativeMinimum: 0
permanently_deleted_users (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Updates a legal hold — response body — status

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)stringAlternativeKnown values: active, released, activating, updating, exporting, releasing
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: active
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: released
$ (anyOf 4)objectAlternative
$ (anyOf 4)..tagstringRequired within parentMust equal: activating
$ (anyOf 5)objectAlternative
$ (anyOf 5)..tagstringRequired within parentMust equal: updating
$ (anyOf 6)objectAlternative
$ (anyOf 6)..tagstringRequired within parentMust equal: exporting
$ (anyOf 7)objectAlternative
$ (anyOf 7)..tagstringRequired within parentMust equal: releasing
$ (anyOf 8)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 8)..tagstringRequired within parentPattern: ^(?!(?:active|released|activating|updating|exporting|releasing)$)

Updates a team member's profile photo — team members Set Profile Photo — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
userModelRequired within parentExpand Sends welcome email to pending team member — request body — body
photoModelRequired within parentExpand Sets a user's profile photo — request body — body photo

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

FieldTypePresenceDescription and constraints
$objectRootInformation about a team member, after the change, like at members/set_profile:2.
member_infoModelRequired within parentExpand 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 V2 — response body — member info

Updates a team member's profile — team members Set Profile V2 — response body — member info

FieldTypePresenceDescription and constraints
$objectRootInformation about a team member.
profileModelRequired within parentExpand Updates a team member's profile — team members Set Profile — response body — profile
rolesJSONOptional
roles (anyOf 1)arrayAlternative
roles (anyOf 1)[]ModelEach itemExpand Get available Team Member Roles for the connected team — response body — roles item
roles (anyOf 2)nullAlternative

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

FieldTypePresenceDescription and constraints
$objectRootExactly 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.
userModelRequired within parentExpand Sends welcome email to pending team member — request body — body
new_emailJSONOptional
new_email (anyOf 1)stringAlternativeMaximum length: 255
Pattern: ^(?:^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$)$
new_email (anyOf 2)nullAlternative
new_external_idJSONOptional
new_external_id (anyOf 1)stringAlternativeMaximum length: 64
new_external_id (anyOf 2)nullAlternative
new_given_nameJSONOptional
new_given_name (anyOf 1)stringAlternativeMaximum length: 50
Pattern: ^(?:[^\/:?*<>"|]*)$
new_given_name (anyOf 2)nullAlternative
new_surnameJSONOptional
new_surname (anyOf 1)stringAlternativeMaximum length: 50
Pattern: ^(?:[^\/:?*<>"|]*)$
new_surname (anyOf 2)nullAlternative
new_persistent_idJSONOptional
new_persistent_id (anyOf 1)stringAlternative
new_persistent_id (anyOf 2)nullAlternative
new_is_directory_restrictedJSONOptional
new_is_directory_restricted (anyOf 1)booleanAlternative
new_is_directory_restricted (anyOf 2)nullAlternative

Referenced models: Sends welcome email to pending team member — request body — body

Updates a team member's profile — team members Set Profile — response body

FieldTypePresenceDescription and constraints
$objectRootInformation about a team member.
profileModelRequired within parentExpand Updates a team member's profile — team members Set Profile — response body — profile
roleModelRequired within parentExpand 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

Updates a team member's profile — team members Set Profile — response body — profile

FieldTypePresenceDescription and constraints
$objectRootProfile of a user as a member of a team.
team_member_idstringRequired within parent
external_idJSONOptional
external_id (anyOf 1)stringAlternative
external_id (anyOf 2)nullAlternative
account_idJSONOptional
account_id (anyOf 1)stringAlternativeMaximum length: 40
Minimum length: 40
account_id (anyOf 2)nullAlternative
emailstringRequired within parent
email_verifiedbooleanRequired within parent
secondary_emailsJSONOptional
secondary_emails (anyOf 1)arrayAlternative
secondary_emails (anyOf 1)[]ModelEach itemExpand Updates a team member's profile — team members Set Profile — response body — profile secondary emails array item
secondary_emails (anyOf 2)nullAlternative
statusModelRequired within parentExpand Updates a team member's profile — team members Set Profile — response body — profile status
nameModelRequired within parentExpand Get information about a user's account — response body — name
membership_typeModelRequired within parentExpand Updates a team member's profile — team members Set Profile — response body — profile membership type
invited_onJSONOptional
invited_on (anyOf 1)stringAlternative
invited_on (anyOf 2)nullAlternative
joined_onJSONOptional
joined_on (anyOf 1)stringAlternative
joined_on (anyOf 2)nullAlternative
suspended_onJSONOptional
suspended_on (anyOf 1)stringAlternative
suspended_on (anyOf 2)nullAlternative
persistent_idJSONOptional
persistent_id (anyOf 1)stringAlternative
persistent_id (anyOf 2)nullAlternative
is_directory_restrictedJSONOptional
is_directory_restricted (anyOf 1)booleanAlternative
is_directory_restricted (anyOf 2)nullAlternative
profile_photo_urlJSONOptional
profile_photo_url (anyOf 1)stringAlternative
profile_photo_url (anyOf 2)nullAlternative
groupsarrayRequired within parent
groups[]stringEach item
member_folder_idstringRequired within parentPattern: ^(?:[-_0-9a-zA-Z:]+)$
root_folder_idstringRequired within parentPattern: ^(?:[-_0-9a-zA-Z:]+)$

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

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)stringAlternativeKnown values: full, limited
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: full
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: limited

Updates a team member's profile — team members Set Profile — response body — profile secondary emails array item

FieldTypePresenceDescription and constraints
$objectRoot
emailstringRequired within parentMaximum length: 255
Pattern: ^(?:^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$)$
is_verifiedbooleanRequired within parent

Updates a team member's profile — team members Set Profile — response body — profile status

FieldTypePresenceDescription and constraints
$JSONRootThe user's status as a member of a specific team.
$ (anyOf 1)stringAlternativeKnown values: active, invited, suspended
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: active
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: invited
$ (anyOf 4)objectAlternative
$ (anyOf 4)..tagstringRequired within parentMust equal: suspended
$ (anyOf 5)objectAlternative
$ (anyOf 5)..tagstringRequired within parentMust equal: removed
$ (anyOf 5).is_recoverablebooleanRequired within parent
$ (anyOf 5).is_disconnectedbooleanRequired within parent

Updates a team member's profile — team members Set Profile — response body — role

FieldTypePresenceDescription and constraints
$JSONRootDescribes which team-related admin permissions a user has.
$ (anyOf 1)stringAlternativeKnown values: team_admin, user_management_admin, support_admin, member_only
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: team_admin
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: user_management_admin
$ (anyOf 4)objectAlternative
$ (anyOf 4)..tagstringRequired within parentMust equal: support_admin
$ (anyOf 5)objectAlternative
$ (anyOf 5)..tagstringRequired within parentMust equal: member_only

Updates the sync settings on a team folder or its contents — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
team_folder_idstringRequired within parentPattern: ^(?:[-_0-9a-zA-Z:]+)$
sync_settingJSONOptional
sync_setting (anyOf 1)ModelAlternativeExpand Creates a new, active, team folder with no members — request body — body sync setting value
sync_setting (anyOf 2)nullAlternative
content_sync_settingsJSONOptional
content_sync_settings (anyOf 1)arrayAlternative
content_sync_settings (anyOf 1)[]ModelEach itemExpand Updates the sync settings on a team folder or its contents — request body — body content sync settings array item
content_sync_settings (anyOf 2)nullAlternative

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

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentMinimum length: 4
Pattern: ^(?:id:.+)$
sync_settingModelRequired within parentExpand Creates a new, active, team folder with no members — request body — body sync setting value

Referenced models: Creates a new, active, team folder with no members — request body — body sync setting value

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.