v1

latestOpenAPI 3.0.32026-08-061810496.7 KB

Secure spaces & folders

Share secure space

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

Request body

emailsstring[] required

Must be a valid email address.

contactsinteger[]

The <code>id</code> of an existing record in the contacts table.

questionstring nullable

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

answerstring nullable

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

bodystring nullable

localestring

silentlyboolean nullable

Example request

{
  "emails": [
    "gbailey@example.net"
  ],
  "contacts": [
    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": 369242,
  "@type": "Folder",
  "@id": "folder_369242",
  "Access": "private",
  "Link": "/vf/hvHU4cTpY0/95fqLI8EeXnYX8cL",
  "OriginalLink": "/vf/hvHU4cTpY0/95fqLI8EeXnYX8cL",
  "URL": "hvHU4cTpY0/95fqLI8EeXnYX8cL",
  "created_at": "2026-06-29T18:54:48.000000Z",
  "deleted_at": null,
  "expires_at": null,
  "updated_at": "2026-06-29T18:54:48.000000Z",
  "creator": {
    "ID": 28153,
    "@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
}