# Edit Recipients 

This operation updates an existing recipient inside a signature request. Users can use this endpoint to modify a signatory’s name, email, OTP settings, recipient, and recipient's private message. Only non-completed recipients can be edited. All signing order and stamp placements will be preserved.

## Request URL

<mark style="color:yellow;">`POST`</mark> /\_apis/sign/api/v2/Requests/{requestId}/editrecipient

To update a recipient, submit the request with the **requestId** and the updated recipient details in the JSON body. A valid OAuth 2.0 access token is required.

### Required Headers

These headers must be included to authenticate the request.

| Header          | Required | Description                                    |
| --------------- | -------- | ---------------------------------------------- |
| `Authorization` | ✅ Yes    | Bearer token obtained from the OAuth 2.0 flow. |
| `Content-Type`  | ✅ Yes    | application/json                               |

### Request Body

The request must include the updated recipient information. Below is the JSON schema:

```json
{
  "UserName": "john.doe",
  "UserEmail": "john.doe@example.com",
  "OTP": {
    "IsRequired": true,
    "AccessCode": "987654",
    "MobileNumber": "+1-202-555-0123",
    "Type": 1
  },
  "PrivateMessage": "Requesting to update my registered email address.",
  "OldUserEmail": "john.doe.old@example.com",
  "AuditDetails": {
    "AuthorType": 1,
    "AuthorIPAddress": "192.168.1.55",
    "Device": "Device Type: Desktop - OS: Windows 11 - Browser: Chrome (v132.0)"
  }
}
```

### Successful Response

```json
{
"requestId" : "UUID"
}
```

### Possible Errors and How to Handle Them

<table><thead><tr><th width="118.33331298828125">Status Code</th><th>Error Message</th><th>Explanation</th></tr></thead><tbody><tr><td><code>400</code></td><td>Bad Request</td><td>The request ID may be missing or malformed.</td></tr><tr><td><code>400</code></td><td>The updated email cannot be the same as the existing one.</td><td>The new email matches the current email: no update is performed. Avoid editing without actual changes.</td></tr><tr><td><code>400</code></td><td>Action denied. You don't have permission to edit recipient users because the user has already completed the request.</td><td>Editing of a recipient who has already completed.</td></tr><tr><td><code>400</code></td><td>The same user cannot be assigned more than once within a single request</td><td>The email to be edited already exists as another recipient in the same request: duplicate users are not allowed.</td></tr><tr><td><code>404</code></td><td>Editing isn’t allowed for this recipient.</td><td>Editing of a recipient who has already completed.</td></tr></tbody></table>

#### Important Notes

* Only **non-completed recipients** can be modified.
* Signing order and stamp placements are **not affected** by recipient edits.
* Audit fields help maintain security and document trail integrity.
* The platform uses **`OldUserEmail`** as a unique identifier to locate the target recipient.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.sign.enadocapp.com/evia-sign-api/v2/edit-recipients.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.