Lock File Batch

POST

https://api.dropboxapi.com/2/files/lock_file_batch

POST

/2/files/lock_file_batch

import requests
url = "https://api.dropboxapi.com/2/files/lock_file_batch"
payload = { "entries": [{ "path": "/John Doe/sample/test.pdf" }] }
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

{
  "entries": [
    {
      ".tag": "success",
      "lock": {
        "content": {
          ".tag": "single_user",
          "created": "2015-05-12T15:50:38Z",
          "lock_holder_account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc",
          "lock_holder_team_id": "dbtid:1234abcd"
        }
      },
      "metadata": {
        ".tag": "file",
        "client_modified": "2015-05-12T15:50:38Z",
        "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
        "file_lock_info": {
          "created": "2015-05-12T15:50:38Z",
          "is_lockholder": true,
          "lockholder_name": "Imaginary User"
        },
        "has_explicit_shared_members": false,
        "id": "id:a4ayc_80_OEAAAAAAAAAXw",
        "is_downloadable": true,
        "name": "Prime_Numbers.txt",
        "path_display": "/Homework/math/Prime_Numbers.txt",
        "path_lower": "/homework/math/prime_numbers.txt",
        "property_groups": [
          {
            "fields": [
              {
                "name": "Security Policy",
                "value": "Confidential"
              }
            ],
            "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa"
          }
        ],
        "rev": "a1c10ce0dd78",
        "server_modified": "2015-05-12T15:50:38Z",
        "sharing_info": {
          "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc",
          "parent_shared_folder_id": "84528192421",
          "read_only": true
        },
        "size": 7212
      }
    }
  ]
}

Lock the files at the given paths. A locked file will be writable only by the lock holder. A successful response indicates that the file has been locked. Returns a list of the locked file paths and their metadata after this operation.

Required scope: files.content.write

Endpoint format: RPC

Authentication: User

This endpoint does not support apps with the app folder permission.

Authentication

AuthorizationBearer

OAuth 2.0 token issued to a specific user. Use Authorization: Bearer <token>.

Public clients should use the authorization code flow with PKCE (S256).

For background or offline access, send token_access_type=offline during authorization and use the returned refresh token to obtain new access tokens.

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

Headers

Request

This endpoint expects an object.

entrieslist of objectsRequired

List of 'entries'. Each 'entry' contains a path of the file which will be locked or queried. Duplicate path arguments in the batch are considered only once.

Response headers

X-Dropbox-Request-IdstringOptional

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

Response

Successful response

entrieslist of objects

Each Entry in the ‘entries’ will have ‘.tag’ with the operation status (e.g. success), the metadata for the file and the lock state after the operation.

Variant:

files.LockFileResultEntry.successobject

Errors

401

Unauthorized Error

403

Forbidden Error

409

Conflict Error

429

Too Many Requests Error

500

Internal Server Error