We are happy to announce the delivery of an OpenAPI Specification and SDKs to wrap PandaDoc API with objects, properties, and methods in your favorite programming language.
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.
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.
Create Document from PDF - unfortunately, we don't support document transaction creation from multiple PDFs at the moment.The single PDF is allowed only.
Document Status - returns a status of the document transaction.
Send Document - move a document transaction to sent status and send an optional email.
Share Document - shares a document transaction as a share URL or embed view.
Download Document - downloads a single PDF no matter if document transaction contains only one document or more. A query parameterseparate_files=true allows you to download files separately.
Delete Document - deletes document transaction with all documents inside.
Link to CRM - connects document transaction to CRMs.
Document Attachments - unfortunately, we don't support document attachments via API for document transactions with more than one document inside.
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.
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.
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.
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.
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.
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:
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: