Articles in this section
Category / Section

Change the recipient of a document using API

Published:
1 min read

In the event that you’ve sent a document to an incorrect signer and the document remains unsigned, there’s no need to worry. BoldSign provides a straightforward option to change the recipient. This guide outlines the steps to effectively modify the recipient of a document.

BoldSign provides an API that allows you to programmatically change the recipient of a document. The following are the code examples in different programming languages to assist you in achieving this task:

Code snippet

curl -X 'PATCH' \ 'https://api.boldsign.com/v1/document/changeRecipient?documentId={Your document Id}' \
    -H 'X-API-KEY: {your API key}' \
    -H 'Content-Type: application/json' \
    -d '{
 "newSignerName": "{New signer name}",
 "reason": "{Reason to change signer}",
 "newSignerEmail": "{Old signer email}",
 "oldSignerEmail": "{New signer email}"
}'

In the above example, replace the documentId with the ID of the document you created earlier. Then, update the newSignerName, newSignerEmail, oldSignerEmail, and reason properties with the appropriate values.

By using these code snippets, the recipient of the document will be updated, and an email will be sent to the new signer containing the signing link for the document.

Was this article useful?
Like
Dislike
Help us improve this page
Please provide feedback or comments
Access denied
Access denied