Documents
Document Status Change
PandaDoc has eight document statuses, but you can manually set your document status to only four:
Document statuses
- Completed - document.completed - API code 2
- Expired - document.voided - code 11
- Paid - document.paid - code 10. Important: You can only set it if you have a payment app connected.
- Declined - document.declined - code 12
🚧 Pass a numeric code for the corresponding document status, for example, 2 for document.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.voided to document.paid
❌ - from document.paid to document.voided
patch/public/v1/documents/{id}/status
Path parameters
idstring required
Specify document ID.
Request body
Example request
{
"status": 12,
"note": "A private note"
}Response
No content