Overview

There are three methods to create a PandaDoc document via API. Here is a quick overview:

*Fields can be arranged but content cannot be edited.

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 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

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

🚧

You can only use the ":" (colon) symbol between variables. This symbol cannot be trailing.

🚧

Role names restrictions

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

PDF/DocX/RTF field tag supported types

Radio buttons limitations

• Radio button options within the same block must be on the same page.
• Preselection of options is not supported.
• Different blocks require unique IDs.
• Values for radio button options must be unique.
• Each document can have a minimum of two and a maximum of 50 radio button options.

📘

Fields in PandaDoc

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

"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"
    },
    "initials": {
        "value": "",
        "role": "user"
    },
    "signature": {
        "value": "",
        "role": "user"
    }
}