Skip to main content
POST
/
matters
/
{matterId}
/
documents
/
files
/
bulk
Add files to a matter
curl --request POST \
  --url https://api.smokeball.com/matters/{matterId}/documents/files/bulk \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json-patch+json' \
  --header 'x-api-key: <api-key>' \
  --data '
[
  {
    "fileName": "court filing.pdf",
    "folderId": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
    "userId": "750eb5c5-ac0b-7d11-4997-e0ce9d8896c8",
    "folderPath": "Court Filings/2023/January",
    "fileAdditionalData": {},
    "dateCreated": "2023-04-23T14:00:00Z",
    "dateModified": "2023-04-24T14:00:00Z"
  }
]
'
import requests

url = "https://api.smokeball.com/matters/{matterId}/documents/files/bulk"

payload = [
    {
        "fileName": "court filing.pdf",
        "folderId": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
        "userId": "750eb5c5-ac0b-7d11-4997-e0ce9d8896c8",
        "folderPath": "Court Filings/2023/January",
        "fileAdditionalData": {},
        "dateCreated": "2023-04-23T14:00:00Z",
        "dateModified": "2023-04-24T14:00:00Z"
    }
]
headers = {
    "x-api-key": "<api-key>",
    "Authorization": "<api-key>",
    "Content-Type": "application/json-patch+json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {
    'x-api-key': '<api-key>',
    Authorization: '<api-key>',
    'Content-Type': 'application/json-patch+json'
  },
  body: JSON.stringify([
    {
      fileName: 'court filing.pdf',
      folderId: 'b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2',
      userId: '750eb5c5-ac0b-7d11-4997-e0ce9d8896c8',
      folderPath: 'Court Filings/2023/January',
      fileAdditionalData: {},
      dateCreated: '2023-04-23T14:00:00Z',
      dateModified: '2023-04-24T14:00:00Z'
    }
  ])
};

fetch('https://api.smokeball.com/matters/{matterId}/documents/files/bulk', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.smokeball.com/matters/{matterId}/documents/files/bulk",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    [
        'fileName' => 'court filing.pdf',
        'folderId' => 'b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2',
        'userId' => '750eb5c5-ac0b-7d11-4997-e0ce9d8896c8',
        'folderPath' => 'Court Filings/2023/January',
        'fileAdditionalData' => [
                
        ],
        'dateCreated' => '2023-04-23T14:00:00Z',
        'dateModified' => '2023-04-24T14:00:00Z'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json-patch+json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.smokeball.com/matters/{matterId}/documents/files/bulk"

	payload := strings.NewReader("[\n  {\n    \"fileName\": \"court filing.pdf\",\n    \"folderId\": \"b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2\",\n    \"userId\": \"750eb5c5-ac0b-7d11-4997-e0ce9d8896c8\",\n    \"folderPath\": \"Court Filings/2023/January\",\n    \"fileAdditionalData\": {},\n    \"dateCreated\": \"2023-04-23T14:00:00Z\",\n    \"dateModified\": \"2023-04-24T14:00:00Z\"\n  }\n]")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json-patch+json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.smokeball.com/matters/{matterId}/documents/files/bulk")
  .header("x-api-key", "<api-key>")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json-patch+json")
  .body("[\n  {\n    \"fileName\": \"court filing.pdf\",\n    \"folderId\": \"b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2\",\n    \"userId\": \"750eb5c5-ac0b-7d11-4997-e0ce9d8896c8\",\n    \"folderPath\": \"Court Filings/2023/January\",\n    \"fileAdditionalData\": {},\n    \"dateCreated\": \"2023-04-23T14:00:00Z\",\n    \"dateModified\": \"2023-04-24T14:00:00Z\"\n  }\n]")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.smokeball.com/matters/{matterId}/documents/files/bulk")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "[\n  {\n    \"fileName\": \"court filing.pdf\",\n    \"folderId\": \"b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2\",\n    \"userId\": \"750eb5c5-ac0b-7d11-4997-e0ce9d8896c8\",\n    \"folderPath\": \"Court Filings/2023/January\",\n    \"fileAdditionalData\": {},\n    \"dateCreated\": \"2023-04-23T14:00:00Z\",\n    \"dateModified\": \"2023-04-24T14:00:00Z\"\n  }\n]"

response = http.request(request)
puts response.read_body
[
  {
    "fileId": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
    "uploadUrl": "",
    "expiry": "2022-04-23T14:30:00Z"
  }
]
{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

Authorizations

ā€‹
x-api-key
string
header
required
ā€‹
Authorization
string
header
required

Path Parameters

ā€‹
matterId
string
required

Body

ā€‹
fileName
string
required

Full name of the file including the file extension

Maximum string length: 256
Example:

"court filing.pdf"

ā€‹
folderId
string | null

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

Example:

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

ā€‹
userId
string | null

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

Example:

"750eb5c5-ac0b-7d11-4997-e0ce9d8896c8"

ā€‹
folderPath
string | null

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

Example:

"Court Filings/2023/January"

ā€‹
fileAdditionalData
object | null

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

ā€‹
dateCreated
string<date-time> | null

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

Example:

"2023-04-23T14:00:00Z"

ā€‹
dateModified
string<date-time> | null

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

Example:

"2023-04-24T14:00:00Z"

Response

When request is accepted. Returns an array of 'UploadFileInfo' objects.

ā€‹
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"