Sign in

v2

latestOpenAPI 3.0.12026-07-262352981007.0 KB
Files

Add file to a matter

Uploads a new file for the specified matter.

post/matters/{matterId}/documents/files

Path parameters

matterIdstring 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 file owner. If null it will fallback to the authenticated user

folderPathstring nullable

Path of the folder to add the file to. If null then the FolderId will be used

fileAdditionalDataobject nullable

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

dateCreatedstring date-time nullable

The original datetime that the file was created. If null the current datetime will be used

dateModifiedstring date-time nullable

The initial datetime that the file was last modified. If null the current datetime will be used

Example request

{
  "fileName": "court filing.pdf",
  "folderId": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
  "userId": "750eb5c5-ac0b-7d11-4997-e0ce9d8896c8",
  "folderPath": "Court Filings/2023/January",
  "dateCreated": "2023-04-23T14:00:00Z",
  "dateModified": "2023-04-24T14:00:00Z"
}

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"
}