---
title: "How to Change Recipient of an eSignature Document via API"
description: "Learn how to change a document's recipient using BoldSign's API by providing the document ID, new signer details, old signer email, and reason for the change."
url: "https://boldsign.com/blogs/how-to-change-the-recipient-of-an-esignature-document-via-api/"
---

1. [Blog](https://boldsign.com/blogs.md)
2. [API](https://boldsign.com/category/api.md)

# How to Change the Recipient of an eSignature Document via API

[Starvritsa Buhungi](https://boldsign.com/author/starvritsa-buhungi/) June 6, 2024 Updated August 21, 2026 3 min read

Sending a document to the wrong signer can be stressful. BoldSign provides a straightforward option to change the recipient if the signer has yet to sign. This guide outlines the steps to do that.

## Editing the recipient via BoldSign API

BoldSign provides an API that allows you to programmatically [change the recipient](https://developers.boldsign.com/how-to-guides/change-recipient-of-the-document?region=us) of a document by providing the following details:

- Document ID
- New signer details
- Old signer email
- Reason for changing the signer

The recipients of the document cannot be changed if the signing process is in any one of the following states:

- Signed
- Declined
- Revoked
- Expired

If the document had two or more recipients and either of the recipients has signed, you can still edit the recipients that have yet to sign the document. The old recipient will receive an email notification regarding the changes made.

## Code snippets

The following are the code examples in different programming languages to assist you in achieving this task.

```
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": "{New signer email}",
  "oldSignerEmail": "{Old signer email}"
}'
```

```
var apiClient = new ApiClient("https://api.boldsign.com", "{your API key}");
var documentClient = new DocumentClient(apiClient);

documentClient.ChangeRecipient(
    "{Your document Id}",
    "{Old signer email}",
    "{Reason to change signer}",
    "{New signer name}",
    "{New signer email}"
);
```

```
import boldsign

configuration = boldsign.Configuration(host="https://api.boldsign.com", api_key="YOUR_API_KEY")

with boldsign.ApiClient(configuration) as api_client:

    document_api = boldsign.DocumentApi(api_client)

    change_recipient_request = boldsign.ChangeRecipient(
        old_signer_email=" old_signer_email ",
        new_signer_name="New signer name",
        new_signer_email=" new_signer_email ",
        reason="Reason to change signer",
    )

    response = document_api.change_recipient(
        document_id="Your_document_Id", change_recipient=change_recipient_request
    )
```

```
<?php
require_once "vendor/autoload.php";

use BoldSign\Configuration;
use BoldSign\Api\DocumentApi;
use BoldSign\Model\ChangeRecipient;

$config = new Configuration();
$config->setHost('https://api.boldsign.com');
$config->setApiKey('YOUR_API_KEY');

$documentApi = new DocumentApi($config);

$documentId = 'YOUR_DOCUMENT_ID';
$oldSignerEmail = 'old@example.com';
$newSignerEmail = 'new@example.com';
$newSignerName = 'John Doe';
$reason = 'Signer replacement requested';

$changeRecipient = new ChangeRecipient();

$changeRecipient->setOldSignerEmail($oldSignerEmail);
$changeRecipient->setNewSignerEmail($newSignerEmail);
$changeRecipient->setNewSignerName($newSignerName);
$changeRecipient->setReason($reason);

$documentApi->changeRecipient($documentId, $changeRecipient);
```

```
ApiClient apiClient = Configuration.getDefaultApiClient();
apiClient.setApiKey("YOUR_API_KEY");
DocumentApi documentApi = new DocumentApi(apiClient);
String documentId = "DOCUMENT_ID";
String oldSignerEmail = "david@cubeflakes.com";
String reason = "Wrongly sent";
String newSignerName = "David";
String newSignerEmail = "luthercooper@cubeflakes.com";
ChangeRecipient changeRecipient = new ChangeRecipient();
changeRecipient.setOldSignerEmail(oldSignerEmail);
changeRecipient.setReason(reason);
changeRecipient.setNewSignerName(newSignerName);
changeRecipient.setNewSignerEmail(newSignerEmail);
documentApi.changeRecipient(documentId, changeRecipient);
System.out.println("Recipient changed successfully for document ID: " + documentId);
}
catch (ApiException e) {
    System.err.println("API call failed: " + e.getMessage());
}
catch (Exception e) {
    System.err.println("An unexpected error occurred: " + e.getMessage());
}
}
}
```

```
import { DocumentApi, ChangeRecipient } from "boldsign";

const documentApi = new DocumentApi("https://api.boldsign.com");
documentApi.setApiKey("YOUR_API_KEY");

// Create request object
const changeRecipient = new ChangeRecipient();
changeRecipient.newSignerName = "David";
changeRecipient.newSignerEmail = "david@cubeflakes.com";
changeRecipient.oldSignerEmail = "hankyWhites@cubeflakes.com";
changeRecipient.reason = "Wrongly sent";

const documentId = "YOUR_DOCUMENT_ID";

async function changeDocumentRecipient() {
  try {
    await documentApi.changeRecipient(documentId, changeRecipient);
    console.log("Recipient changed successfully!");
  } catch (error: any) {
    console.error("Error occurred while calling the API:", error.message);
  }
}

changeDocumentRecipient();
```

## Conclusion

Fixing errors when you send documents for signature doesn’t need to be difficult. Using BoldSign’s API, you can easily change the recipient of an unsigned document, making sure it gets to the right person. Start your [30-day free BoldSign trial](https://account.boldsign.com/signup?planId=1018\&utm_source=boldsignblogs\&utm_medium=redirect\&utm_campaign=boldsign) today and see how easy is to change your document recipients for yourself.

We value your feedback, so please share your thoughts below. If you have any questions or need more information about our services, don’t hesitate to [schedule a demo](https://boldsign.com/request-demo.md) or reach out to our support team through our [support portal](https://support.boldsign.com/support/tickets/create).

Topics [API integration](https://boldsign.com/blogs/tag/api-integration.md)

## Sign documents 3x faster

Send, sign and manage documents securely and efficiently.

[Try it today](https://account.boldsign.com/signup?planId=1018\&utm_source=boldsignblogs\&utm_medium=redirect\&utm_campaign=boldsign)

## Starvritsa Buhungi

Starvritsa is a Technical Assistant at BoldSign, channelling her passion into crafting top-tier content for users through meticulous documentation. She creates content across various formats, including API tutorials, help articles, and comprehensive guides.

[More posts by Starvritsa Buhungi](https://boldsign.com/author/starvritsa-buhungi/)

## Related posts

- [API](https://boldsign.com/category/api.md) September 29, 2026 10 min read

  ## [How to Migrate from Docusign Without Losing Templates or Workflow Continuity](https://boldsign.com/blogs/migrate-from-docusign.md)

  Learn how to migrate from Docusign while protecting templates, signed records, and active workflows. Explore key risks, a practical checklist, and next steps.

- [API](https://boldsign.com/category/api.md) September 25, 2026 10 min read

  ## [Build vs Buy an eSignature API: What Should You Choose?](https://boldsign.com/blogs/build-vs-buy-esignature-api-guide.md)

  Compare the real cost, compliance risk, launch speed, and maintenance burden of building vs buying an eSignature API before you commit.

- [API](https://boldsign.com/category/api.md) September 22, 2026 9 min read

  ## [What Are the Common Challenges When Using Signature APIs in Software Development](https://boldsign.com/blogs/common-signature-api-challenges.md)

  Explore the common challenges developers face with a Signature API, from authentication issues to PDF rendering, webhooks, templates, and rate limits.

Get started

## Sign up for your free trial today!

[Start free trial](https://account.boldsign.com/signup?planId=1018)

- 30-day free trial
- No credit card required

*Picture: A completed employment contract: signed by John Doe on 11/03/2026, all parties have signed*
