Update Document

Use the PATCH method to update a PandaDoc document.

Document status

You can only update a document in the Draft status (document.draft).

After creating a new document, it usually retains a document.uploaded status for 3-5 seconds while the document syncs across PandaDoc servers. When the document is available for further API calls, the document moves to the document.draft state. Use Document Status or Webhooks to check document status.

Path Params
string
required

Document ID

Body Params
string

The name of the document.

recipients
array of objects

The list of recipients you're sending the document to. The ID or email are required. If the ID is passed, an existing recipient will be updated. If the email is passed, a new recipient will be added to CC.

recipients
fields
object

Set specific values to the fields. This object maps merge field names to their corresponding values.

Each key represents a merge field name, and each value is an object containing the data to populate that field with. The structure allows you to pre-populate various field types including text inputs, checkboxes, dropdowns, and date fields.

Key Points:

  • Keys must match the exact merge field names from your template or file.
  • Values must be wrapped in an object with a value property.
  • Supported value types: string, number, boolean.
  • Date fields should use RFC 3339 format (e.g., '2019-12-31T00:00:00.000Z').
  • Signature fields cannot be pre-filled.

Example Usage:

  • Text field: "CustomerName": {"value": "John Doe"}
  • Checkbox: "AgreeToTerms": {"value": true}
  • Date field: "DeliveryDate": {"value": "2019-12-31T00:00:00.000Z"}
tokens
array of objects

Create or initialize multiple variables with their values using tokens/values list.

tokens
tags
array of strings

Mark your document with one or several tags.

tags
metadata
object

You can pass arbitrary data in the key-value format to associate custom information with a document. This information is returned in any API requests for the document details by id. If metadata exists in a document then the value will be updated. Otherwise, metadata will be added to the document.

pricing_tables
array of objects
pricing_tables
tables
array of objects
tables
images
array of objects

You can pass a list of images to image blocks (one image in one block) for replacement.

images
texts
array of objects

You can pass a list of texts to text blocks for replacement.

texts
Responses
204

No content

Language
Credentials
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json