Launch Workflow Batch

Endpoint URL	SDK Method
`https://api.inkit.com/v1/invoke/batch` (POST)	N/A

Request properties

Property	Type	Required	Description
`name`	String	No	The name of the batch. While this property is optional, we highly recommend that you use it so that you can better track your batches.
`description`	String	Yes	The description the batch.
`flows`	Object[]	Yes	The set of workflows for the batch.

`flows`

Property	Type	Required	Description
`flow_id`	String	No	The ID of the workflow.
`name`	String	No	The name of the workflow object.
`merge_paremeters`	Object	Yes	The key-value pairs that you'll use when generating an element of your batch. The data you supply here will replace the fields you have embedded in your document templates.

Response properties

Property	Type	Description
`description`	String	The description of the batch.
`flows_data`	Object	The set of destination IDs of the batch.
`id`	String	The ID of the batch.
`name`	String	The name of the batch.

`flows_data`

Property	Type	Required	Description
`document_id`	String	No	The ID of the document generated by the workflow.
`id`	String	No	The invocation ID of the workflow.

Example request and response

curl --request POST \
     --url https://api.inkit.com/v1/invoke/batch \
     --header 'Content-Type: application/json' \
     --header 'X-Inkit-API-Token: ENTER YOUR API KEY' \
     --header 'accept: application/json' \
     --data '
{
  "name": "Batch Name",
  "description": "Batch description",
  "flows": [
    {
      "merge_parameters": {
        "name": "test"
      },
      "flow_id": "flow_n4ir7mMl3AgXEkmucqYjq",
      "name": "Individual job"
    }
  ]
}
'

{
    "description": "Batch description",
    "flows_data": [
        {
            "document_id": "doc_kqZCmOpAy7JrpMkMRJW2l",
            "id": "rend_21XvBWhhn9Tl9qQSztqzMe"
        }
    ],
    "id": "fb_4AO6oyjh5yc9jvRKJplghb",
    "name": "Batch Name"
}