v1

latestSwagger 2.02026-07-134026156.7 KB
Submission Batches

Generate multiple PDFs

Generates up to 50 PDFs in a single request. Each submission can use a different template and data. Supports both synchronous (wait for all PDFs) and asynchronous processing. More efficient than individual requests when creating multiple PDFs.

See also:

post/submissions/batches

Query parameters

waitboolean

Wait for submission batch to be processed before returning. Set to false to return immediately. Default: true (on sync.* subdomain)

Request body

metadataobject
template_idstring nullable
template_versionstring nullable
testboolean

Example request

{
  "metadata": {
    "job_id": 54321
  },
  "test": true,
  "template_id": null,
  "template_version": null,
  "submissions": [
    {
      "test": false,
      "template_id": "tpl_1234567890abcdef01",
      "template_version": "draft",
      "data": {
        "first_name": "Johnny",
        "last_name": "Smith"
      },
      "metadata": {
        "submission_number": 1
      }
    },
    {
      "template_id": "tpl_1234567890abcdef01",
      "template_version": "latest",
      "data": {
        "first_name": "Jane",
        "last_name": "Doe"
      },
      "metadata": {
        "submission_number": 2
      }
    }
  ]
}

Response

some PDFs with invalid data

status'success' | 'error' required
errorstring
errorsstring[]