Document Recipients
Delete Document Recipient
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.
delete/public/v1/documents/{id}/recipients/{recipient_id}
Request
- Base URLhttps://api.pandadoc.com
- Auth
- API key in header Authorization
- or OAuth 2Authorization codehttps://app.pandadoc.com/oauth2/authorizeToken URLhttps://api.pandadoc.com/oauth2/access_token
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
idstring required
Document UUID
recipient_idstring required
Recipient UUID
Response
No content
Changes
No recorded changes to this operation across all 2 revisions of this API.