🚧

Using the Sandbox Key

When you use a sandbox API key during the free trial period, the sender and recipient email addresses must be from the same organisation (email domain).

Document State

• Upload Status (document.uploaded): After creating a new document via API, it enters the document.uploaded status and being processed asynchronously. Once the document is ready for further API interactions, it transitions to the document.draft status. To monitor the status, use Document Status or Webhooks.
• Draft Status (document.draft): A document can only be sent when it is in the document.draft status.
• Sent Status (document.sent): Moving a document to the document.sent status finalizes its structure, allowing recipients to sign the document.
• Approval Workflow: If the document is created from a template with an approval workflow enabled, the document will move to the document.waiting_approval status after being sent. Once approved, you must make another API call to transition the document to the `document.sent status.

Send and Silence Notifications

Depending on your workflow, you may want to disable notifications for both the sender and recipients, especially if you're embedding a document for signing. Here's how notifications work and how to manage them:

• Default Notifications: By default, PandaDoc sends an email or SMS to the recipient when a document is sent. The sender is notified about changes in the document status based on their notification preferences.
• Customizing Email Notifications: You can customize the notification email by passing optional subject and message attributes. Additional customization options are available under the workspace settings in the "Branding and Email" section.
• Silent Mode (silent: true):
  • Use the silent: true parameter to disable email notifications for document sent, viewed, commented on, or completed events. It also disables automated (scheduled) reminders, though you can still send manual (on-demand) reminders. We recommend always including the silent parameter to facilitate seamless document email management, as this setting is preserved throughout the entire document lifecycle.
  • "Document Approval" notifications are not affected by the silent: true parameter.
  • This setting is particularly useful when embedding documents for signing or using your own delivery method.
    
    

Select Approver from Group

If you have previously set up an approval workflow with selectable groups on the UI, you can select a particular approver from this group. Learn more about selectable groups.
To set an approver, we recommend to follow these steps:

1. Run the Document Details request.
2. Copy the steps part from the approval_execution section of the response into the selected_approvers field of the Send Document payload.
3. Modify your payload according to business needs: set is_selected to true for one approver.

📘

Note: You can change the selected approver only if you revert your document back to the document.draft status.