PDFMonkey

Generate and manage documents using PDFMonkey templates.

Render a PDF from a PDFMonkey template with custom payload data.

Parameters

Parameter	Type	Required	Description
`template_id`	string	Yes	Identifier of the PDFMonkey template to render.
`payload`	object	Yes	JSON payload that fills the template variables.
`metadata`	object	No	Optional metadata to attach to the generated document.
`test_mode`	boolean	No	Whether to create the document in test mode (not counted toward usage).

Response

{
  "document_id": "mock_value",
  "document_status": "mock_value",
  "status": "mock_value"
}

Delete a generated PDFMonkey document by its identifier.

Parameters

Parameter	Type	Required	Description
`document_id`	string	Yes	Identifier of the PDFMonkey document to delete.

Response

{
  "deleted": true,
  "document_id": null,
  "status": "mock_value"
}

Retrieve the processing status and download URL for a PDFMonkey document.

Parameters

Parameter	Type	Required	Description
`document_id`	string	Yes	The PDFMonkey document identifier to inspect.

Response

{
  "document_id": null,
  "document_status": "mock_value",
  "download_url": "mock_value",
  "status": "mock_value"
}