Skip to main content
PUT
/
instances
/
{id}
Update instance
curl --request PUT \
  --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",
  "priority": "V",
  "tags": [
    "<string>"
  ],
  "step_assignments": [
    {
      "step_id": 123,
      "user_id": 123
    }
  ]
}
'
{
  "process": "<string>",
  "name": "",
  "deadline": "2023-11-07T05:31:56Z",
  "priority": "V",
  "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>

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

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

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[]

List of active step IDs of the instance

​
step_deadlines
string

List of instance step deadlines

​
public_url
string

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

Minimum string length: 1
​
stage
string
Minimum string length: 1