POST /public/v1/documents/{id}/recipients
Add a CC recipient to a document.
🚧 Before you start
To add a CC recipient, please ensure that:
- You have the 'Can Manage Recipients' permission.
- This recipient is already created in your contacts. If not, add them using the Create Contact endpoint.
To add a new CC recipient to a document, two parameters must be included in the request body:
kind: Set this parameter tocontactto specify an individual contact.id: Input the ID of the desired contact.
To retrieve the contact's ID, use the List Contacts endpoint to access a list of all contacts, and then locate the desired contact by searching using the name or email address within the returned list.
Document status
You can add CC recipients in any document status except for the 'Expired' (document.voided) and 'Declined' (document.declined).
📘 Email notification to access the document
Note: When a document is in one of the following statuses: 'Sent' (
document.sent), 'Viewed' (document.viewed), 'Completed' (document.completed), 'Waiting for Payment' (document.waiting_pay), or 'Paid' (document.paid), any added CC recipient will receive an instant notification at their email address, allowing them access to the document.
Servers
- https://api.pandadoc.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
String | Yes |
Document UUID |
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 |
|---|---|---|---|
id |
String | Yes |
Contact uuid. |
kind |
String | Yes |
Valid values:
Default value: "contact" |
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.