Sign in

v2

latestOpenAPI 3.0.12026-07-262352981007.0 KB
Files

Patch a file

Updates the metadata for a file or uploads a new version of the file

patch/matters/{matterId}/documents/files/{fileId}

Path parameters

matterIdstring required
fileIdstring required

Request body

fileNamestring required

Full name of the file including the file extension

folderIdstring nullable

Unique identifier of the folder to add the file to. If null it will be placed in the root folder

userIdstring nullable

Unique identifier of the user modifying the file. If null it will fallback to the authenticated user

fileAdditionalDataobject nullable

Collection of KeyValuePair(string, string) to update File meta data.

isFavoriteboolean nullable

Flag indicating whether this file is a favorite. If null it will be ignored

Example request

{
  "fileName": "court filing.pdf",
  "folderId": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
  "userId": "750eb5c5-ac0b-7d11-4997-e0ce9d8896c8"
}

Response

When request is accepted. Returns an 'UploadFileInfo' object.

fileIdstring nullable

Unique identifier of the file.

uploadUrlstring nullable

Temporary Link to upload file.

Important note: When uploading to this URL, set the 'Content-Type' header to an empty value.

Example cURL: curl --location --request PUT 'URL_GOES_HERE' \ --header 'Content-Type: ""' \ --data '@/C:/dir/test.pdf'

expirystring date-time

Expiry date/time when the upload link is no longer accessible.

Example response

{
  "fileId": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
  "expiry": "2022-04-23T14:30:00Z"
}