v1

latestOpenAPI 3.0.32026-08-061810496.7 KB

Secure spaces, folders & files

Update

put/api/2/folders/{userFolder}

Request body

namestring nullable

Must be at least 1 character. Must not be greater than 255 characters.

secured_spaceboolean nullable

Options.

visibility'private' | 'public' nullable

expiry_intervalinteger nullable

expires_atstring nullable

Must be a valid date.

IncreasedSecurityboolean nullable

readonly_messagesboolean nullable

TODO: find a better key.

messages_modestring nullable

TODO: find a better key.

create_folder_policy'external' | 'internal' nullable

TODO: find a better key'.

sort'!name' | 'name' | 'date' | '!date' nullable

Pivot.

colorstring nullable

propertiesinteger[] required

Example request

{
  "name": "b",
  "visibility": "public",
  "expiry_interval": 16,
  "expires_at": "2026-06-29T18:54:49",
  "create_folder_policy": "internal",
  "sort": "name",
  "color": "architecto",
  "defaults": {
    "file": {
      "properties": [
        "architecto"
      ]
    },
    "commented": {
      "properties": [
        "architecto"
      ]
    }
  },
  "properties": [
    16
  ]
}

Response

IDinteger

@typestring

@idstring

Accessstring

Linkstring

OriginalLinkstring

URLstring

created_atstring

deleted_atstring nullable

expires_atstring nullable

updated_atstring

Scopestring

Namestring

SecuredSpaceboolean

MessagesModeinteger

CreateFolderPolicystring nullable

Example response

{
  "ID": 369245,
  "@type": "Folder",
  "@id": "folder_369245",
  "Access": "private",
  "Link": "/vf/hvHUBu5dUe/aETBLhDATtAdZ1UY",
  "OriginalLink": "/vf/hvHUBu5dUe/aETBLhDATtAdZ1UY",
  "URL": "hvHUBu5dUe/aETBLhDATtAdZ1UY",
  "created_at": "2026-06-29T18:54:50.000000Z",
  "deleted_at": null,
  "expires_at": null,
  "updated_at": "2026-06-29T18:54:50.000000Z",
  "creator": {
    "ID": 28163,
    "@type": "User",
    "Title": null,
    "Name": "Lafayette Considine",
    "FirstName": "Lafayette",
    "LastName": "Considine",
    "Avatar": "https://alex-macbook.tail9fea4c.ts.net/images/avatar_male.png",
    "Scope": "external",
    "HasContact": false
  },
  "Scope": "external",
  "Name": "Bailey Ltd",
  "SecuredSpace": false,
  "MessagesMode": 0,
  "CreateFolderPolicy": null
}