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

POST /_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:

{
  "UserName": "john.doe",
  "UserEmail": "[email protected]",
  "OTP": {
    "IsRequired": true,
    "AccessCode": "987654",
    "MobileNumber": "[phone]",
    "Type": 1
  },
  "PrivateMessage": "Requesting to update my registered email address.",
  "OldUserEmail": "[email protected]",
  "AuditDetails": {
    "AuthorType": 1,
    "AuthorIPAddress": "192.168.1.55",
    "Device": "Device Type: Desktop - OS: Windows 11 - Browser: Chrome (v132.0)"
  }
}

Successful Response

{
"requestId" : "UUID"
}

Possible Errors and How to Handle Them

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

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.