Create instance

post

https://core.nextmatter.com/api/instances/

Create and return a new instance of the workflow

Body Params

name

string | null

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.

process

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.

deadline

date-time | null

Time by which the instance should be completed

priority

string | null

enum

The priority of the instance. If you don't send this parameter, the priority will be "Regular". Other options are the following:

Allowed:

Tags

step_assignments

array of objects

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".

step_assignments

Response

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201