v1

latestOpenAPI 3.0.32026-08-061810496.7 KB

Files

Update file

post/api/1/documents/{userFile}/update

Request body

pageinteger

restrict-downloadsboolean nullable

expires_atstring nullable

Must be a valid date.

access'private' | 'public' nullable

namestring nullable

Must be at least 1 character.

editableboolean nullable

versioninteger nullable

Must be at least 1.

Example request

{
  "page": 16,
  "expires_at": "2026-06-29T18:54:47",
  "access": "private",
  "name": "ngzmiyvdljnikhwa",
  "editable": true,
  "version": 79
}

Response

Idinteger

@typestring

@idstring

Accessstring

Linkstring

OriginalLinkstring

URLstring

created_atstring

deleted_atstring nullable

expires_atstring nullable

updated_atstring

Scopestring

Editableboolean

RestrictDownloadsboolean

Example response

{
  "Id": 2101666,
  "@type": "Document",
  "@id": "file_2101666",
  "Access": "private",
  "Link": "/dl/hvHU1Qv116/vU623rzdATjlMCPa",
  "OriginalLink": "/dl/hvHU1Qv116/vU623rzdATjlMCPa",
  "URL": "hvHU1Qv116/vU623rzdATjlMCPa",
  "created_at": "2026-06-29T18:54:47.000000Z",
  "deleted_at": null,
  "expires_at": null,
  "updated_at": "2026-06-29T18:54:47.000000Z",
  "creator": {
    "ID": 28149,
    "@type": "User",
    "Title": null,
    "Name": "Juliet King",
    "FirstName": "Juliet",
    "LastName": "King",
    "Avatar": "https://alex-macbook.tail9fea4c.ts.net/images/avatar_male.png",
    "Scope": "external",
    "HasContact": false
  },
  "Scope": "external",
  "Editable": false,
  "RestrictDownloads": false,
  "current": {
    "Id": 751107910,
    "Name": "Anderson LLC.csh",
    "Size": 1705120483,
    "Source": "WEB",
    "ExternalLink": null,
    "MimeType": "application/vnd.shana.informed.formdata",
    "Stored": true,
    "AVStatus": null,
    "created_at": "2026-06-29T18:54:47.000000Z",
    "Thumbnail": null,
    "@type": "Version",
    "updated_at": "2026-06-29T18:54:47.000000Z",
    "deleted_at": null
  }
}