v1

latestSwagger 2.02026-07-134026156.7 KB
PDF Submissions

Generate a PDF

Creates a PDF submission by filling in a template with data. Supports both synchronous (default) and asynchronous processing. Set wait: false to return immediately.

See also:

post/templates/{template_id}/submissions

Path parameters

template_idstring required

Query parameters

waitboolean

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

Request body

dataobject required
editableboolean
expires_ininteger
field_overridesobject
metadataobject
passwordstring
testboolean
versionstring

Example request

{
  "version": "draft",
  "data": {
    "first_name": "John",
    "last_name": "Smith",
    "phone_number": "+11234567890"
  },
  "metadata": {
    "foo": 123,
    "bar": "baz"
  },
  "expires_in": 300
}

Response

submission created

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