As you may know, we've delivered document bundling and document transaction.

  • Document bundling allows you to group multiple documents, send and track them all at once, within a single transaction. Please be informed that we don't support document bundling via API at the moment.
  • Document transaction is the dispatch of either one or multiple documents that have been bundled together, as part of the same agreement process.

Please find more details here.

📘

What is a Document Transaction?

Basically, document transaction=document with a single or a few documents inside.

In this topic, you may find new possibilities and restrictions for the API. Your current API integrations will work in the same manner without any changes on your end.

Method

Multiple documents in a document transaction supported?

  • *GET** List Documents

Yes

  • *POST** Create Document from PandaDoc Template

Partially (see details below)

  • *POST** Create Document from PDF

No (only a single document is allowed)

  • *GET** Document Status

Yes

  • *GET** Document Details

Yes

  • *POST** Send Document

Yes

Share Document

Yes

  • *GET** Download Document

Yes

  • *DELETE** Delete Document

Yes

Link to CRM

Yes

Document Attachments

No (attachments allowed for a single document only)

  • *PATCH** Change Document Status (manually)

Yes

  • *PATCH** Update Document Ownership

Yes

  • *PATCH** Transfer All Documents Ownership

Yes

  • List Documents - includes all documents transactions no matter how many documents are inside each of them.
  • Create Document from PandaDoc Template - you can create a document transaction from a template. The only thing that is not supported yet is a set of documents' names in the document transaction.
2866

We're pleased to announce a new set of PandaDoc API features. This time we've delivered Contacts management via API. A scope includes:

How it may help you?

  • In case you have your own contact list, you can sync it with PandaDoc's List Contacts and keep it up-to-date.
  • You don't need to pass recipient details any time you create a document via API. An email is all that you need for a recipient in the Create Document request. Everything else will be automatically taken from the Contact Details.
  • If you need to have different details for a recipient in the document you can override the first and last names in the Create Document request.
  • In case you need it permanently, you can easily update contact details with Update Contact via API.

Please be informed that we've added a few methods for ownership management via API.

Members via API

Now you can easily retrieve information about all members in the workspace using:

Create on member's behalf

Also, we've added the possibility to set document owner in the document creation request.

"owner":{
	"membership_id":"radQBiBkU7MBk59NSgaGfd"
}

or

"owner":{
	"email":"[email protected]"
}

Update Document Ownership

Moreover, we've added a new method to Update Document Owner.

{
    "membership_id":"radQBiBkU7MBk59NSgaGfd"
}

Transfer All Documents Ownership

The last but not least, we've added the possibility to Transfer Documents Ownership to another member in a single API call.

{
    "from_membership_id": "Dqsxp4jNnFcS63tJEgLJGN",
    "to_membership_id": "radQBiBkU7MBk59NSgaGfd"
}

More details you may find in the Transfer document ownership to another user topic.

When you complete documents or make payments offline, it is handy to be able to make your PandaDoc records reflect this change. Being able to change the document status is important for keeping all of your signed contracts in one place.
Having eight document statuses, you can manually change your document status to four only: Completed, Expired, Paid, or Declined.

1028

Manual Status change matrix

Document Statuses:

  • 2: document.completed
  • 8: document.rejected
  • 10: document.paid
  • 12: document.declined

Find more details in Change Document Status (manually) and [Editor 2.0] Manually change document status topics.

Please be informed that we've removed a restriction to link documents to CRMs in document.draft status only.
Now you can easily link your documents in any status you want.

Please find more details via the link.

Attachments

We're pleased to inform you that we've added attachments management via API. Now you can easily add a file as an attachment to the document in document.draft status. You are also able to retrieve details and delete an attachment.

🚧

Limits

You can attach up to 10 files, and no file can exceed 50MB.

Please check our documentation for more details - Document Attachments.

Collect file fields

In addition, we've added the possibility to access files that recipients uploaded to the document in Document Details response or On Document Status Change webhooks payload. A direct link is placed in the URL parameter of the collect files field.

{
            "uuid": "oW9RTHp96QMWswTSdE8bsN",
            "name": "Upload",
            "title": "Upload",
          	"placeholder": "Upload",
            "assigned_to": {
                "id": "Fx7CgaVgpGbJBgZ4i5oTx8",
                "first_name": "Jane",
                "last_name": "Roe",
                "email": "john",
                "recipient_type": "signer",
                "has_completed": false,
                "role": "",
                "type": "recipient"
            },
            "value": {
                "name": "file.pdf",
                "url": "https://uploadfields.pandadoc-static.com"
            }
 }

Send variable value as a link in the Create Document from PandaDoc Template request with Editor 2.0 and we automatically convert it to a clickable one.
Use the following format:

"tokens": [
        {
            "name": "Payment.Link",
            "value": "https://stripe.com/"
        }
    ],
🚧

The difference in names

Variables in the UI are equal to tokens in the API.

Upload images to Image blocks when creating a new document with the Create Document from PandaDoc Template request. Please note the image blocks in the template should be pre-set before creating a document.

Upload an image as a URL parameter inside a JSON request body in the following format:

"images": [
    	{
    		"name": "Image 1",
    		"urls": [
    			"https://s3.amazonaws.com/pd-static-content/public-docs/pandadoc-panda-bear.png"
    		]
    	}
    ]

Also, we support multipart/form-data content type so that you can upload an image through form data.

Image formats supported: GIF, JPG, PNG.

📘

The difference with Classic Editor

Editor 2.0 allows only one image per block and doesn't allow images in text blocks.

Make your document dynamic with Content Placeholders and add content to a document in the creation request. Decide what Content Library Items to add (different countries' terms & conditions, pricing tables with predefined currencies, additional fields or product information, etc.) to the document based on the data merged. In addition, you can prefill fields/variables values, add items to pricing tables, and assign recipients to roles from the specific Content Library Item.

See a detailed guide on how to use a content placeholder.
In addition, please review the documentation via the link.

2822

Template with Content Placeholder only

2870

Document with replaced Content Placeholder by Content Library Item (pricing table inside)

We've added new filtering options by dates in List Documents.
Now you can easily filter documents by:

  • date_created;
  • date_modified;
  • date_ completed.

See the full list of query parameters for filtering here.