Team Folder Update Sync Settings

POST

https://api.dropboxapi.com/2/team/team_folder/update_sync_settings

POST

/2/team/team_folder/update_sync_settings

import requests
url = "https://api.dropboxapi.com/2/team/team_folder/update_sync_settings"
payload = {
    "team_folder_id": "123456789",
    "content_sync_settings": [
        {
            "id": "id:a4ayc_80_OEAAAAAAAAAXw",
            "sync_setting": { ".tag": "default" }
        }
    ],
    "sync_setting": { ".tag": "default" }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())

Response headers

HTTP/1.1 200 OK
X-Dropbox-Request-Id: string

{
  "content_sync_settings": [
    {
      "id": "id:a4ayc_80_OEAAAAAAAAAXw",
      "sync_setting": {
        ".tag": "default"
      }
    }
  ],
  "is_team_shared_dropbox": false,
  "name": "Marketing",
  "status": {
    ".tag": "active"
  },
  "sync_setting": {
    ".tag": "default"
  },
  "team_folder_id": "123456789",
  "quota_limit": 123456789
}

Updates the sync settings on a team folder or its contents. Use of this endpoint requires that the team has team selective sync enabled.

Required scope: team_data.content.write

Endpoint format: RPC

Authentication: Team

Authentication

AuthorizationBearer

Team-level OAuth 2.0 token issued to a Dropbox Business admin. Use Authorization: Bearer <token>.

Obtain via the authorization code flow with team-scoped permissions.

Grants access to team-wide administrative operations.

You can generate a short-lived access token from the App Console; see Testing with a generated token.

Request

This endpoint expects an object.

team_folder_idstringRequiredformat: "[-_0-9a-zA-Z:]+"

The ID of the team folder.

content_sync_settingslist of objects or nullOptional

Sync settings to apply to contents of this team folder.

sync_settingobject or nullOptional

Sync setting to apply to the team folder itself. Only meaningful if the team folder is not a shared team root.

Variant:

files.SyncSettingArg.defaultobjectRequired

On first sync to members' computers, the specified folder will follow its parent folder's setting or otherwise follow default sync behavior.

Response headers

X-Dropbox-Request-IdstringOptional

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

Response

Successful response

content_sync_settingslist of objects

Sync settings applied to contents of this team folder.

is_team_shared_dropboxboolean

True if this team folder is a shared team root.

namestring

The name of the team folder.

statusobject

The status of the team folder.

Variant:

team.TeamFolderStatus.activeobject

The team folder and sub-folders are available to all members.

sync_settingobject

The sync setting applied to this team folder.

Variant:

files.SyncSetting.defaultobject

On first sync to members' computers, the specified folder will follow its parent folder's setting or otherwise follow default sync behavior.

team_folder_idstringformat: "[-_0-9a-zA-Z:]+"

The ID of the team folder.

quota_limitlongOptional

The quota limit in bytes for this team folder namespace tree.

Errors

401

Unauthorized Error

403

Forbidden Error

409

Conflict Error

429

Too Many Requests Error

500

Internal Server Error