v1

latestOpenAPI 3.0.32026-08-061810496.7 KB

Secure spaces, folders & files

Create a folder / secure space

post/api/2/folders

Request body

namestring required

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

parentsinteger[] required

secured_spaceboolean nullable

Options.

visibility'private' | 'public' nullable

create_folder_policy'external' | 'internal' nullable

permissions_source'parent' nullable

Creation options.

content_source'template' | 'folder' nullable

This field is required when <code>content_source_id</code> is present.

content_source_idinteger nullable

This field is required when <code>content_source</code> is present.

messagestring nullable

Sharing.

message_priorityinteger nullable

message_preview'notification' nullable

Example request

{
  "name": "b",
  "parents": [
    16
  ],
  "secured_space": true,
  "visibility": "public",
  "create_folder_policy": "internal",
  "permissions_source": "parent",
  "content_source": "template",
  "content_source_id": 16,
  "message": "architecto",
  "message_priority": 16,
  "message_preview": "notification",
  "shares": [
    {
      "email": "zbailey@example.net",
      "message": "architecto",
      "message_priority": 16,
      "message_preview": "notification"
    }
  ]
}

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": 369246,
  "@type": "Folder",
  "@id": "folder_369246",
  "Access": "private",
  "Link": "/vf/hvHUCOB7HU/aYyIspSD6UH9sRWP",
  "OriginalLink": "/vf/hvHUCOB7HU/aYyIspSD6UH9sRWP",
  "URL": "hvHUCOB7HU/aYyIspSD6UH9sRWP",
  "created_at": "2026-06-29T18:54:50.000000Z",
  "deleted_at": null,
  "expires_at": null,
  "updated_at": "2026-06-29T18:54:50.000000Z",
  "creator": {
    "ID": 28164,
    "@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
}