Launch Flow Batch

Launches a set of flows

Endpoint URLSDK Method (POST)N/A

Request properties

nameStringNoThe name of the batch. While this property is optional, we highly recommend that you use it so that you can better track your batches.
descriptionStringYesThe description the batch.
flowsObject[]YesThe set of flows for the batch.


flow_idStringNoThe ID of the flow.
nameStringNoThe name of the flow object.
merge_paremetersObjectYesThe 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

descriptionStringThe description of the batch.
flows_dataObjectThe set of destination IDs of the batch.
idStringThe ID of the batch.
nameStringThe name of the batch.


document_idStringNoThe ID of the document generated by the flow.
idStringNoThe invocation ID of the flow.

Example request and response

curl --request POST \
     --url \
     --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"