PATCH /public/v1/documents/{id}/status
PandaDoc has eight document statuses, but you can manually set your document status to only four:
Document statuses
- Completed -
document.completed- API code2 - Expired -
document.voided- code11 - Paid -
document.paid- code10. Important: You can only set it if you have a payment app connected. - Declined -
document.declined- code12
🚧 Pass a numeric code for the corresponding document status, for example,
2fordocument.completed.
Find more details in [Editor 2.0] Manually change document status topic.
| Current Status | To Completed: | To Expired: | To Paid: | To Declined: |
|---|---|---|---|---|
| Draft | YES | NO | YES | YES |
| Approved | NO | NO | NO | NO |
| Sent | YES | YES | NO | YES |
| Viewed | YES | YES | NO | YES |
| Completed (Auto) | NO | NO | NO | YES |
| Waithing for payment | NO | NO | YES | YES |
| Paid | NO | NO | NO | NO |
| Expired | YES | NO | YES | YES |
| Declined | YES | NO | YES | NO |
✅ - from
document.voidedtodocument.paid❌ - from
document.paidtodocument.voided
Servers
- https://api.pandadoc.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
String | Yes |
Specify 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 |
|---|---|---|---|
notify_recipients |
Boolean | No |
Send a notification email about the status change to all recipients. |
note |
String | No |
Provide “private notes” regarding the manual status change. |
status |
Integer | Yes |
Number code for the target document status. See notes for the codes corresponding to each status. Valid values:
|
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.