POST /public/v1/documents/{id}/send
Servers
- https://api.pandadoc.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
String | Yes |
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 |
|---|---|---|---|
message |
String | No |
A message that will be sent by email with a link to a document to sign. |
forwarding_settings |
Object | No |
Forwarding settings |
forwarding_settings.forwarding_with_reassigning_allowed |
Boolean | No |
Allow forwarding with reassigning |
forwarding_settings.forwarding_allowed |
Boolean | No |
Allow forwarding |
sender |
Object | No |
You can set a sender of a document as an |
subject |
String | No |
Value that will be used as the email subject. |
silent |
Boolean | No |
Disables sent, viewed, comment, and completed email notifications for document recipients and the document sender. By default, notifications emails are sent for specific actions. If set as true, it won't affect the "Approve document" email notification sent to the Approver. |
selected_approvers |
Object | No |
Configuration for selected approvers |
selected_approvers.steps[] |
Array | No |
Approval steps |
selected_approvers.steps[].id |
String | Yes |
Step ID |
selected_approvers.steps[].group |
Object | Yes |
Group information |
selected_approvers.steps[].group.id |
String | Yes |
Group ID |
selected_approvers.steps[].group.assignees[] |
Array | Yes |
Assignees for the group |
selected_approvers.steps[].group.assignees[].is_selected |
Boolean | No |
Whether the user is selected |
selected_approvers.steps[].group.assignees[].user |
String | No |
User ID |
selected_approvers.steps[].group.type |
String | Yes |
Group type |
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.