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 '{
  "name": "",
  "deadline": "2023-11-07T05:31:56Z",
  "priority": "V",
  "tags": []
}'
{
  "name": "",
  "process": "<string>",
  "deadline": "2023-11-07T05:31:56Z",
  "priority": "V",
  "tags": [],
  "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": {},
  "active_step_ids": [
    123
  ],
  "step_deadlines": [
    {}
  ],
  "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
string
required

Body

Response

200 - application/json; version=v1

The response is of type object.