Folder Lock

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


The unique identifier for this folder lock.


The object type, always folder_lock.

string / date-time

When the folder lock object was created.

The user or group that created the lock.

The folder that the lock applies to.


The lock type, always freeze.

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


Whether deleting the folder is restricted.


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