GET
/
matters
/
{matterId}
/
documents
/
files
/
{fileId}
/
upload
Get upload url for a file
curl --request GET \
  --url https://api.smokeball.com/matters/{matterId}/documents/files/{fileId}/upload \
  --header 'Authorization: <api-key>' \
  --header 'x-api-key: <api-key>'
{
  "fileId": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
  "uploadUrl": "",
  "expiry": "2022-04-23T14:30:00Z"
}

Authorizations

​
x-api-key
string
header
required
​
Authorization
string
header
required

Path Parameters

​
matterId
string
required
​
fileId
string
required

Response

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

​
fileId
string | null

Unique identifier of the file.

Example:

"b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2"

​
uploadUrl
string | null

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'

Example:

""

​
expiry
string<date-time>

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

Example:

"2022-04-23T14:30:00Z"