PDF Monkey · Example Payload

Create Document Sync

Example request and response for creating and generating a PDF document synchronously. The request waits until generation completes (up to 6 minutes) before returning.

PDFDocument GenerationTemplatesHandlebarsREST APIWebhooks

Create Document Sync is an example object payload from PDF Monkey, with 4 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

titledescriptionrequestresponse

Example Payload

{
  "title": "Create Document Synchronously Example",
  "description": "Example request and response for creating and generating a PDF document synchronously. The request waits until generation completes (up to 6 minutes) before returning.",
  "request": {
    "method": "POST",
    "url": "https://api.pdfmonkey.io/api/v1/documents/sync",
    "headers": {
      "Authorization": "Bearer YOUR_API_KEY",
      "Content-Type": "application/json"
    },
    "body": {
      "document": {
        "document_template_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "payload": {
          "customer_name": "John Smith",
          "contract_date": "2024-06-13",
          "terms": "Net 30"
        },
        "status": "pending"
      }
    }
  },
  "response": {
    "status": 200,
    "headers": {
      "Content-Type": "application/json"
    },
    "body": {
      "document_card": {
        "id": "d4e5f6a7-b8c9-0123-defa-234567890123",
        "app_id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
        "created_at": "2024-06-13T14:35:00Z",
        "document_template_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "document_template_identifier": "contract-template",
        "download_url": "https://cdn.pdfmonkey.io/documents/d4e5f6a7-b8c9-0123-defa-234567890123/download?token=signed_token_here",
        "failure_cause": null,
        "filename": "contract-2024-06-13.pdf",
        "meta": null,
        "output_type": "pdf",
        "preview_url": "https://cdn.pdfmonkey.io/documents/d4e5f6a7-b8c9-0123-defa-234567890123/preview",
        "public_share_link": null,
        "status": "success",
        "updated_at": "2024-06-13T14:35:07Z"
      }
    }
  }
}