Box Developer Documentation
Log in

Folder Lock

This resource is used by enpoints in the version 2024.0. For more details, see Box API versioning.

Folder locks define access restrictions placed by folder owners to prevent specific folders from being moved or deleted.

string
12345678

The unique identifier for this folder lock.

string
folder_lock

The object type, always folder_lock.

string (date-time)
2020-09-14T23:12:53Z

When the folder lock object was created.

User (Base) object

The user or group that created the lock.

Folder (Mini) object

The folder that the lock applies to.

string
freeze

The lock type, always freeze.

object

The operations that have been locked. Currently the move and delete operations cannot be locked separately, and both need to be set to true.

boolean
true

Whether deleting the folder is restricted.

boolean
true

Whether moving the folder is restricted.

Response Example

{
  "id": "12345678",
  "type": "folder_lock",
  "created_at": "2020-09-14T23:12:53Z",
  "created_by": {
    "id": "11446498",
    "type": "user"
  },
  "folder": {
    "id": "12345",
    "type": "folder",
    "etag": "1",
    "name": "Contracts",
    "sequence_id": "3"
  },
  "lock_type": "freeze",
  "locked_operations": {
    "delete": true,
    "move": true
  }
}