v1

latestOpenAPI 3.0.2Apache-2.02026-07-142963051.0 MB

Folder Locks

Create folder lock

Creates a folder lock on a folder, preventing it from being moved and/or deleted.

You must be authenticated as the owner or co-owner of the folder to use this endpoint.

post/folder_locks

Request body

Example request

{
  "locked_operations": {
    "move": true,
    "delete": true
  },
  "folder": {
    "type": "folder",
    "id": "1234567890"
  }
}

Response

Returns the instance of the folder lock that was applied to the folder, including the user that applied the lock and the operations set.

idstring

The unique identifier for this folder lock.

typestring

The object type, always folder_lock.

created_atstring date-time

When the folder lock object was created.

lock_typestring

The lock type, always freeze.

Example response

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