Update a recipient

Updates the details of an existing recipient.

If you update the recipient’s name, a new recipient will be created behind the scenes with a new id. The original recipient will be removed from the envelope, and any existing signing tokens or active sessions will be invalidated immediately.

If you update the recipient’s email or mobile, and the recipient is eligible to receive correspondence, a new signing email or SMS will be sent automatically.

This endpoint is also used to recover from a failed or declined recipient status. Updating the recipient will reset their status back to sent and reinitiate the signing process.

​

Parameters

PUT /v1/recipients/:id

{
  "id": "255e591c2c9fe1bc99be1ec03075b402",
  "name": "Ted Annature",
  "email": "ted@annature.com.au",
  "mobile": "+61422000000",
  "type": "signer",
  "status": "sent",
  "message": "Lorem ipsum dolor sit amet.",
  "password": true,
  "muted": false,
  "order": 1,
  "declined_reason": "Lorem ipsum dolor sit amet.",
  "created": "2019-12-17T05:30:00Z",
  "sent": "2019-12-17T05:30:00Z",
  "declined": "2019-12-17T05:30:00Z",
  "completed": "2019-12-17T05:30:00Z",
  "redirects": {
    "session_completed": "https://..",
    "session_declined": "https://.."
  }
}