v1

latestOpenAPI 3.0.3MIT2026-07-24122271451.2 KB
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 StatusTo Completed:To Expired:To Paid:To Declined:
DraftYESNOYESYES
ApprovedNONONONO
SentYESYESNOYES
ViewedYESYESNOYES
Completed (Auto)NONONOYES
Waithing for paymentNONOYESYES
PaidNONONONO
ExpiredYESNOYESYES
DeclinedYESNOYESNO

✅ - 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

status2 | 10 | 11 | 12 required

Number code for the target document status. See notes for the codes corresponding to each status.

notestring

Provide “private notes” regarding the manual status change.

notify_recipientsboolean

Send a notification email about the status change to all recipients.

Example request

{
  "status": 12,
  "note": "A private note"
}

Response

No content