We're happy to announce that Field ID and Type are now available in the Document Details, Template Details, Content Library Item Details, and Webhooks.

Field ID parameter is unique across a document, so now it's possible to reference exactly the field you need.
Type parameter helps to process field values in different ways according to their types.

650
"fields": [
    {
      "field_id": "VAT_field",
      "type": "text",
      "uuid": "9330094d-cea5-46cf-869e-058b18a5ae15",
      "name": "vat_number",
      "title": "",
      "placeholder": "VAT number",
      "value": "CY99999999L",
      "merge_field": "vat_number"
    }
  ]

Currently available field types are:

  • text
  • dropdown
  • date
  • checkbox
  • signature
  • initials
  • collect_file

We're pleased to announce filtering options by document owner and recipients/approver in the List Documents.
Now you can easily filter documents by:

  • membership_id (several parameters are allowed) for document owner. You can find it in the List Members.
  • contact_id for a recipient or approver. You can find it in the List Contacts.

See the full list of query parameters for filtering in the List Documents section.

Filter by contact_id:

  • https://api.pandadoc.com/public/v1/documents?contact_id=TyVJD8phcyXrGGXBSfgcwd

Filter by membership_id:

  • https://api.pandadoc.com/public/v1/documents?membership_id=XGgtcUP85DuUjqu7j5LoPL

Filter by several membershi_ids

  • https://api.pandadoc.com/public/v1/documents?membership_id=XGgtcUP85DuUjqu7j5LoPL&membership_id=TyVJD8phcyXrGGXBSfgcwd

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.

MethodMultiple documents in a document transaction supported?
GET List DocumentsYes
POST Create Document from PandaDoc TemplatePartially (see details below)
POST Create Document from PDFNo (only a single document is allowed)
GET Document StatusYes
GET Document DetailsYes
POST Send DocumentYes
Share DocumentYes
GET Download DocumentYes
DELETE Delete DocumentYes
Link to CRMYes
Document AttachmentsNo (attachments allowed for a single document only)
PATCH Change Document Status (manually)Yes
PATCH Update Document OwnershipYes
PATCH Transfer All Documents OwnershipYes
  • 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

Contacts Management

by Yurii Losinets

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.

Ownership Management

by Yurii Losinets

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.

[Editor 2.0] Link to CRM

by Yurii Losinets

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.