DELETE /public/v1/documents/{id}/recipients/{recipient_id}
Remove a recipient from a document.
🚧 Before you start
Please ensure that you have the 'Can Manage Recipients' permission.
To remove a recipient from a document, you must specify their ID in the path parameter (note that this is different from their contact's ID). The recipient's ID can be retrieved via the Document Details endpoint.
Document status
- Removing a signer is only possible when the document is in the 'Draft' (
document.draft) status and this action will unassign all fields associated with that signer. - Removing a CC recipient is allowed in any document status except for the 'Expired' (
document.voided) and 'Declined' (document.declined). If a CC recipient is removed, their access will be revoked.
Servers
- https://api.pandadoc.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
String | Yes |
Document UUID |
recipient_id |
String | Yes |
Recipient UUID |
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.