Use this endpoint to reassign fields to another signer.
Before you start
To change a signer in a document, please ensure that you:
- Have the 'Can Manage Recipients' permission.
- Already have a contact for the new recipient. If you haven't created a contact yet, you can do so using the Create Contact endpoint.
You can reassign fields to another signer before the original signer has signed the document. You can choose any person except those recipients who have already signed the document.
The API path includes the recipient_id the original signer and the request body must include the following two parameters:
id: This should be the unique ID of the contact you want to use as a replacement for the original signer.kind: Set this parameter tocontactto specify an individual contact (in the future, we plan to introduce the concept of "contact groups").
Once you execute the call, the original signer will be entirely removed from the document. If you wish to retain the original signer as a CC recipient, you can re-add them using the Add CC Recipient endpoint.
Pre-filled fields
If you change the signer in a document that has already been sent, the signer's pre-filled fields will be completely reset. In the 'Draft' (
document.draft) status, pre-filled fields will remain.