Create Document Section from File

We support PDF, DocX, and 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

📘

Using this endpoint you can add a section from template to the existing document

To create a document from file - use Create Document from File Upload endpoint

To create a document from template - use Create Document from Template endpoint

🚧

Usage specifics

1. This method uses a multipart/form-data request type instead of the application/json typically found in the PandaDoc API. This is to accommodate the upload of the included document.
2. You can send a URL instead of a file in the document creation request.
   In this case, you need to use the application/json content type and add the URL parameter in the body request. As an example, see Create from public PDF guide for more details.
3. A file you upload is not stored in your PandaDoc account, so you have to upload it with every request.

❗️

Limitations

1. This method does not support multiple documents.
2. The maximum supported file size is 50 MB. API returns "413 Request entity too large" in case of bigger files.
3. 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).

⏱️

Document Section creation is a non-blocking (asynchronous) operation

The document creation process may take some time.

With a successful request, you receive a response with the created upload ID and status document_sections_upload.uploaded. After processing completes on our servers, usually a few seconds, the document moves to the document_sections_upload.PROCESSED status.

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

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

Error handling