v1

latestOpenAPI 3.0.32026-08-061810496.7 KB

Secure spaces & folders

Update secure space or folder

post/api/1/folders/{userFolder}/update

Request body

namestring

Must not be greater than 255 characters.

client_spaceboolean

secure_spaceboolean

IncreasedSecurityboolean

readonly_messagesboolean

scope'private' | 'public' nullable

expires_atstring nullable

Must be a valid date.

files_sort'!name' | 'name' | 'date' | '!date' nullable

expiry_intervalinteger nullable

messages_modestring nullable

colorstring nullable

Example request

{
  "name": "b",
  "client_space": true,
  "secure_space": true,
  "IncreasedSecurity": true,
  "scope": "public",
  "expires_at": "2026-06-29T18:54:48",
  "files_sort": "!name",
  "expiry_interval": 16,
  "color": "architecto",
  "defaults": {
    "file": {
      "properties": [
        "architecto"
      ]
    },
    "commented": {
      "properties": [
        "architecto"
      ]
    }
  }
}

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": 369241,
  "@type": "Folder",
  "@id": "folder_369241",
  "Access": "private",
  "Link": "/vf/hvHU48xY1I/puVLwz8PPRRDwl6y",
  "OriginalLink": "/vf/hvHU48xY1I/puVLwz8PPRRDwl6y",
  "URL": "hvHU48xY1I/puVLwz8PPRRDwl6y",
  "created_at": "2026-06-29T18:54:48.000000Z",
  "deleted_at": null,
  "expires_at": null,
  "updated_at": "2026-06-29T18:54:48.000000Z",
  "creator": {
    "ID": 28152,
    "@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
}