Endpoint URL SDK Method https://api.inkit.com/v1/invoke/batch (POST)N/A
Property Type Required Description nameString 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. descriptionString Yes The description the batch. flowsObject[] Yes The set of flows for the batch.
Property Type Required Description flow_idString No The ID of the flow. nameString No The name of the flow object. merge_paremetersObject 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.
Property Type Description descriptionString The description of the batch. flows_dataObject The set of destination IDs of the batch. idString The ID of the batch. nameString The name of the batch.
Property Type Required Description document_idString No The ID of the document generated by the flow. idString No The invocation ID of the flow.
cURL
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"
}
]
}
'
JSON
{
"description": "Batch description",
"flows_data": [
{
"document_id": "doc_kqZCmOpAy7JrpMkMRJW2l",
"id": "rend_21XvBWhhn9Tl9qQSztqzMe"
}
],
"id": "fb_4AO6oyjh5yc9jvRKJplghb",
"name": "Batch Name"
}
