Skip to main content
PATCH
/
instances
/
{id}
/
Partially update instance
curl --request PATCH \
  --url https://core.nextmatter.com/api/instances/{id}/ \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "process": "<string>",
  "name": "",
  "deadline": "2023-11-07T05:31:56Z",
  "tags": [
    "<string>"
  ],
  "step_assignments": [
    {
      "step_id": 123,
      "user_id": 123
    }
  ]
}
'
import requests

url = "https://core.nextmatter.com/api/instances/{id}/"

payload = {
    "process": "<string>",
    "name": "",
    "deadline": "2023-11-07T05:31:56Z",
    "tags": ["<string>"],
    "step_assignments": [
        {
            "step_id": 123,
            "user_id": 123
        }
    ]
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    process: '<string>',
    name: '',
    deadline: '2023-11-07T05:31:56Z',
    tags: ['<string>'],
    step_assignments: [{step_id: 123, user_id: 123}]
  })
};

fetch('https://core.nextmatter.com/api/instances/{id}/', 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/instances/{id}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'process' => '<string>',
    'name' => '',
    'deadline' => '2023-11-07T05:31:56Z',
    'tags' => [
        '<string>'
    ],
    'step_assignments' => [
        [
                'step_id' => 123,
                'user_id' => 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/instances/{id}/"

	payload := strings.NewReader("{\n  \"process\": \"<string>\",\n  \"name\": \"\",\n  \"deadline\": \"2023-11-07T05:31:56Z\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"step_assignments\": [\n    {\n      \"step_id\": 123,\n      \"user_id\": 123\n    }\n  ]\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://core.nextmatter.com/api/instances/{id}/")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"process\": \"<string>\",\n  \"name\": \"\",\n  \"deadline\": \"2023-11-07T05:31:56Z\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"step_assignments\": [\n    {\n      \"step_id\": 123,\n      \"user_id\": 123\n    }\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://core.nextmatter.com/api/instances/{id}/")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"process\": \"<string>\",\n  \"name\": \"\",\n  \"deadline\": \"2023-11-07T05:31:56Z\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"step_assignments\": [\n    {\n      \"step_id\": 123,\n      \"user_id\": 123\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body
{
  "process": "<string>",
  "name": "",
  "deadline": "2023-11-07T05:31:56Z",
  "tags": [
    "<string>"
  ],
  "step_assignments": [
    {
      "step_id": 123,
      "user_id": 123
    }
  ],
  "url": "<string>",
  "id": 123,
  "started_time": "2023-11-07T05:31:56Z",
  "completed_time": "2023-11-07T05:31:56Z",
  "aborted_time": "2023-11-07T05:31:56Z",
  "last_updated_time": "2023-11-07T05:31:56Z",
  "process_snapshot": "<string>",
  "active_step_ids": [
    123
  ],
  "step_deadlines": "<string>",
  "public_url": "<string>",
  "stage": "<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

Path Parameters

id
integer
required

A unique integer value identifying this workflow instance.

Body

application/json
process
string<uri>
required

The related workflow resource URI. For example https://core.nextmatter.com/api/processes/[IDoftheworkflowinNM]/. To find the workflow ID, navigate to the respective workflow at app.nextmatter.com, and copy the number at the very end of the URL.

name
string | null
default:""

The name of the instance. If automatic naming has been enabled, the name parameter needs to be an empty string, null, or completely left out.

Maximum string length: 255
deadline
string<date-time> | null

Time by which the instance should be completed

priority
enum<string> | null

The priority of the instance. If you don't send this parameter, the priority will be "Regular". Other options are V - "Very High" and H - "High".

Available options:
V,
H
tags
string[]

A list of string tags separated by a comma

step_assignments
object[]

A list of user assignments per step. This is only required for workflows that have at least one step assignee set to "Select user at workflow start".

Response

200 - application/json
process
string<uri>
required

The related workflow resource URI. For example https://core.nextmatter.com/api/processes/[IDoftheworkflowinNM]/. To find the workflow ID, navigate to the respective workflow at app.nextmatter.com, and copy the number at the very end of the URL.

name
string | null
default:""

The name of the instance. If automatic naming has been enabled, the name parameter needs to be an empty string, null, or completely left out.

Maximum string length: 255
deadline
string<date-time> | null

Time by which the instance should be completed

priority
enum<string> | null

The priority of the instance. If you don't send this parameter, the priority will be "Regular". Other options are V - "Very High" and H - "High".

Available options:
V,
H
tags
string[]

A list of string tags separated by a comma

step_assignments
object[]

A list of user assignments per step. This is only required for workflows that have at least one step assignee set to "Select user at workflow start".

url
string<uri>
read-only

The instance resource URI. For example https://core.nextmatter.com/api/instances/[instance_id]/.

id
integer
read-only
started_time
string<date-time>
read-only
completed_time
string<date-time> | null
read-only
aborted_time
string<date-time> | null
read-only
last_updated_time
string<date-time>
read-only
process_snapshot
string
read-only

A snapshot of the workflow structure. If you set "inject_values" query parameter to "true", this will return the input values of the form fields., If you set "steps_time_frame" query parameter to "true", this will return the completion values of the form fields.

active_step_ids
integer[]
read-only

List of active step IDs of the instance

step_deadlines
string
read-only

List of instance step deadlines

public_url
string
read-only

The public URL of the instance (for status tracking), if enabled in the workflow settings

Minimum string length: 1
stage
string
read-only
Minimum string length: 1