POST
/
v1
/
recipients
/
{recipient_id}
/
replace
// POST https://api.signatureapi.com/v1/recipients/{recipient_id}/replace
// X-API-Key: key_test_...
{
  "name": "Jane Doe",
  "email": "jane@example.com"
}

{
  "id": "re_8Unml6TyhNN8923Rminm40",
  "envelope_id": "52872f0e-b919-4d69-89cd-e7e56af00548",
  "type": "signer",
  "key": "provider",
  "name": "Jane Doe",
  "email": "jane@example.com",
  "status": "pending",
  "completed_at": null,
  "status_updated_at": "2025-12-31T15:00:00.000Z"
}
Recipients can be replaced as long as they haven’t completed yet, and the envelope status is in_progress.

​
Path Parameters

recipient_id
string
required

The unique identifier of a recipient.

​
Body Parameters

name
string
required

The name of the recipient.

email
string
required

The email address of the recipient.

​
Returns

Returns a 201 Created status code along with the new recipient object if successful, or an error otherwise.

// POST https://api.signatureapi.com/v1/recipients/{recipient_id}/replace
// X-API-Key: key_test_...
{
  "name": "Jane Doe",
  "email": "jane@example.com"
}

{
  "id": "re_8Unml6TyhNN8923Rminm40",
  "envelope_id": "52872f0e-b919-4d69-89cd-e7e56af00548",
  "type": "signer",
  "key": "provider",
  "name": "Jane Doe",
  "email": "jane@example.com",
  "status": "pending",
  "completed_at": null,
  "status_updated_at": "2025-12-31T15:00:00.000Z"
}

Was this page helpful?

Get a recipientResend request