Skip to main content
API version 2024.0 Folder locks define access restrictions placed by folder owners to prevent specific folders from being moved or deleted.
​
id
string
example: 12345678The unique identifier for this folder lock.
​
type
string
example: folder_lockThe object type, always folder_lock.
​
created_at
string(date-time)
example: 2020-09-14T23:12:53ZWhen the folder lock object was created.
​
created_by
User (Base)object
The user or group that created the lock.
​
folder
Folder (Mini)object
The folder that the lock applies to.
​
lock_type
string
example: freezeThe lock type, always freeze.
​
locked_operations
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.
{
  "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
  }
}