PATCH /public/v1/documents/{id}

Servers

https://api.pandadoc.com

Path parameters

Name	Type	Required	Description
`id`	String	Yes	Document ID

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`name`	String	No	The name of the document.
`recipients[]`	Array	No	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[].id`	String	No
`recipients[].email`	String	No
`recipients[].last_name`	String	No
`recipients[].first_name`	String	No
`pricing_tables[]`	Array	No
`pricing_tables[].name`	String	Yes
`pricing_tables[].sections[]`	Array	No
`pricing_tables[].sections[].multichoice_enabled`	Boolean	No	Default value: false
`pricing_tables[].sections[].default`	Boolean	No
`pricing_tables[].sections[].title`	String	Yes
`pricing_tables[].sections[].rows[]`	Array	No
`pricing_tables[].sections[].rows[].data`	Object	No
`pricing_tables[].sections[].rows[].options`	Object	No
`pricing_tables[].sections[].rows[].options.optional_selected`	Boolean	No
`pricing_tables[].sections[].rows[].options.qty_editable`	Boolean	No
`pricing_tables[].sections[].rows[].options.optional`	Boolean	No
`pricing_tables[].sections[].rows[].custom_fields`	Object	No
`pricing_tables[].options`	Object	No
`pricing_tables[].data_merge`	Boolean	No	When set to true all field names in data rows must be passed as external names defined in the template.
`metadata`	Object	No	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.
`fields`	Object	No	You may pass a list of fields/values which exist in a document. Please use `Merge Field` property of the fields like the key.
`tokens[]`	Array	No	You can pass a list of tokens/values. If a token name exists in a document then the value will be updated. Otherwise, a new token will be added to the document.
`tokens[].name`	String	Yes
`tokens[].value`	String	Yes

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.