Upload file

Create a new file for the organization and (optionally) a specific workflow or instance. Use the URI from the response to reference the file in your workflow. Note that base64 is not natively supported as a direct upload format. If you have a base64 file, convert it to binary before uploading.

It accepts a file field in the request data, with a file.

POST /files/

Upload file

cURL

curl --request POST \
  --url https://core.nextmatter.com/api/files/ \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "created_time": "2023-11-07T05:31:56Z",
  "process": 123,
  "process_instance": 123
}
'

import requests

url = "https://core.nextmatter.com/api/files/"

payload = {
    "created_time": "2023-11-07T05:31:56Z",
    "process": 123,
    "process_instance": 123
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({created_time: '2023-11-07T05:31:56Z', process: 123, process_instance: 123})
};

fetch('https://core.nextmatter.com/api/files/', 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://core.nextmatter.com/api/files/",
  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([
    'created_time' => '2023-11-07T05:31:56Z',
    'process' => 123,
    'process_instance' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$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://core.nextmatter.com/api/files/"

	payload := strings.NewReader("{\n  \"created_time\": \"2023-11-07T05:31:56Z\",\n  \"process\": 123,\n  \"process_instance\": 123\n}")

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

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/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://core.nextmatter.com/api/files/")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"created_time\": \"2023-11-07T05:31:56Z\",\n  \"process\": 123,\n  \"process_instance\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://core.nextmatter.com/api/files/")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"created_time\": \"2023-11-07T05:31:56Z\",\n  \"process\": 123,\n  \"process_instance\": 123\n}"

response = http.request(request)
puts response.read_body

201

{
  "created_time": "2023-11-07T05:31:56Z",
  "process": 123,
  "process_instance": 123,
  "file": "<string>"
}

Authorizations

Authorization · string · header · default: Api-Key YOUR_NM_API_KEY · required

Authentication is API key based. As an admin, you can generate an API key in Next Matter by going to Company > Next Matter API keys.

When sending requests to the API, authenticate by passing the API key in the "Authorization" HTTP header, prepended with the string "Api-Key ".

For example:

Authorization: Api-Key xyzabc.12fsfe242ubdgakew

Body

application/json

created_time · string<date-time>

process · integer | null

process_instance · integer | null

Response

201 - application/json

created_time · string<date-time>

process · integer | null

process_instance · integer | null

file · string<uri> · read-only