v1

latestSwagger 2.02026-07-134026156.7 KB
Combine PDFs

Merge submission PDFs, template PDFs, or custom files

Combines multiple PDFs from various sources into a single PDF file. Supports merging submission PDFs, template PDFs, custom files, other merged PDFs, and PDFs from URLs. Merges the PDFs in the order provided.

post/combined_submissions

Request body

delete_custom_filesboolean
expires_ininteger
metadataobject
passwordstring
testboolean

Example request

{
  "source_pdfs": [
    {
      "type": "submission",
      "id": "sub_1234567890abcdef01"
    },
    {
      "type": "template",
      "id": "tpl_1234567890abcdef01",
      "template_version": "1.0.0"
    },
    {
      "type": "template",
      "id": "tpl_1234567890abcdef01"
    },
    {
      "type": "submission",
      "id": "sub_1234567890abcdef02"
    },
    {
      "type": "custom_file",
      "id": "cfi_1234567890abcdef01"
    },
    {
      "type": "combined_submission",
      "id": "com_1234567890abcdef01"
    },
    {
      "type": "url",
      "url": "http://example.com/test-pdf.pdf"
    }
  ],
  "metadata": {
    "foo": 123,
    "bar": "baz"
  },
  "expires_in": 300,
  "delete_custom_files": true
}

Response

combined submission created

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