Move a document to sent status and send an optional email.
You can send a document only for documents with a
document.draftstatus. After creating a new document, it retains a
document.uploadedstatus for usually 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.draftstate. Use Document Status or Webhooks to check document status.
Moving a document to the
document.sent status finalizes the document structure in preparation for completion by recipients.
If a template used for document creation has "Approval Workflow" turned on, this document will be moved to 'document.waiting_approval' status. Once approved, you need to make the call again to move the document to 'document.sent' status.
By default, PandaDoc sends a
document.sent notification email to the recipient as well as any internal notifications the sender has opted for. This can be bypassed by passing
silent: true. Using this will suppress sent, viewed, comment and completed document notifications. This is useful when you are using alternative delivery methods such as linking to the document or embedding the document.
Settings "silent": true
It is important to know that "true" value will disable sent, viewed, comment and completed document email notifications. "Document Approval" notification won't be affected by this parameter.
When opting to send an email, passing the optional
message attribute will result in an email like the following. At this time the email is not customizable beyond the user avatar. If you wish to perform any additional customization, we recommend generating view session links and using your own email distribution methods.