Current Version Limitations

Images in sections are currently not supported.

Pricing tables note

Each pricing table must have a unique name to populate it with data correctly.

A PandaDoc template is a document template created and edited in the PandaDoc web application. Our help center has further information on PandaDoc templates.

If you don't have any PandaDoc Template yet, you can easily create one by clicking Copy a Sample PandaDoc template. This will open the PandaDoc application in a new tab, copy the sample template into your account, and create a new document from the template.

Using this endpoint you can add a section to the existing document. The section is created from a file you upload. The file can be a PDF, DocX, or RTF.

We've prepared two samples that you can use to test the request.

Download them here:

• Download a Sample PDF with Form Fields
• Download a Sample PDF with Field Tags

Limitations

• This method does not support multiple documents.
• The maximum supported file size is 50 MB. API returns "413 Request entity too large" in case of bigger files.
• PandaDoc does not support creating document from a PDF with encrypted files (to check whether a file is encrypted or not, try Get info -> Secure: Password Encrypted).

PDF Form Fields

PandaDoc recognizes PDF form fields. To enable this feature, pass the optional parse_form_fields value as true when making a create document section API call. We support Text fields, Dropdowns, and Signature fields.

If you would like to pass additional parameters to configure PDF form fields, use the PDF field name as an optId. You can use a PDF editor such as Adobe Acrobat, Foxit to get and edit field names in your PDF.

Download a Sample PDF with Form Fields

PDF/DocX/RTF Field Tags

This parsing format allows a word processor such as Microsoft Word or Google Docs to prepare a document and save it in PDF, DocX or RTF format.

Within the text, PandaDoc parses field tags. A field tag starts and ends with brackets. The field tag includes basic information on how to create a form field in the PandaDoc document. The request JSON object optId can also extend this information for even greater control.

Here is an example of how the field tag in a PDF/DocX/RTF is converted to a text field in the PandaDoc document:

Download a Sample PDF with Field Tags

PDF Field Tag Key

Role names restrictions

Underscores are not supported in role names for a file with a Field Tag.

PDF/DocX/RTF Field Tag Supported Types

"fields": {  
  "textfield": {  
      "value": "Jane",
      "role": "user"
  },
  "dropdown": {
      "value": "opt1",
      "role": "user",
      "options":[
        "opt1",
        "opt2",
        "opt3"
      ]
  },
  "checkbox": {  
      "value": true,
      "role": "user"
  },
  "date":{
      "value": "2022-05-20",
      "role": "user"
  },
  "signature": {  
      "value": "",
      "role": "user"
  }
}

Fields in PandaDoc

The following article explains how to use Fields: Everything you need to know about Fields

Signing order

Set a signing order for document section sections created from a file.

"recipients": [  
  {  
    "email": "[email protected]",
    "first_name": "Josh",
    "last_name": "Ron",
    "role": "user",
    "signing_order": 1
  }
]

Signing order in PandaDoc

The following article explains how to use signing order: How to use signing order

Error handling