> ## Documentation Index
> Fetch the complete documentation index at: https://docs.annature.com.au/llms.txt
> Use this file to discover all available pages before exploring further.

# Update a recipient

Updates the details of an existing recipient in an envelope. This endpoint supports updates for both in-progress envelopes and draft envelopes, with different rules and behaviors depending on the envelope status.

When updating a recipient in a **draft** envelope, all recipient attributes can be modified freely. This is useful for preparing envelopes prior to sending without triggering any recipient correspondence.

When updating a recipient in an **in-progress** envelope (i.e. already sent), additional rules apply:

* All active recipient sessions are immediately expired. If the recipient is currently viewing or signing the envelope, their session will be forcibly closed.
* If the recipient's email address is changed, all previously sent signing emails become invalid, and a new email is sent automatically.
* If the recipient's mobile number is changed, all previously sent SMS links are invalidated, and a new SMS is sent automatically.
* Updates to name, message, password, authentication, and redirects will take effect immediately.

**Note:** Updating a recipient in a **recalled envelope** is not supported via the API. This must be done through the dashboard.

This endpoint uses the HTTP `PUT` method, which fully replaces the recipient's state with the values provided in the request body. All updatable fields must be explicitly included — any fields omitted will be reset to `null` or their default values.

## Parameters

<ParamField path="name" required>
  The full name of the recipient.
</ParamField>

<ParamField path="email" required>
  The email address of the recipient.
</ParamField>

<ParamField path="mobile" type="string">
  The recipient's mobile number, supplied in E.164 format. This number is used to send an SMS with a link to open the envelope.

  While it is technically possible to use both `mobile` and `sms_auth`, we strongly recommend using only one. Sending both the envelope link and the OTP to the same device does not meet the requirements for two-factor authentication.
</ParamField>

<ParamField path="type" type="string" required>
  Recipient type. Required when updating a recipient in a draft envelope.

  Allowed values: `signer`, `viewer`, `carbon-copy`.
</ParamField>

<ParamField path="message" type="string">
  A custom message shown to the recipient. Overrides the envelope message.
</ParamField>

<ParamField path="password" type="string">
  A password the recipient must enter to access the envelope.
</ParamField>

<ParamField path="sms_auth" type="string">
  Enables SMS-based two-factor authentication by specifying the recipient’s mobile number, formatted in E.164.

  When supplied, Annature will send a one-time code (OTP) to the recipient. This code must be entered before they can access the envelope.

  While it is technically possible to use both `sms_auth` and `mobile`, we strongly recommend using only one. Sending both the envelope link and the OTP to the same device does not meet the requirements for two-factor authentication.
</ParamField>

<ParamField path="muted" type="boolean">
  If true, Annature will not send any emails, SMS messages, or automatic reminders to this recipient.
</ParamField>

<ParamField path="order" type="integer">
  The recipient's position in the signing order. Only applicable in draft envelopes; cannot be changed for in-progress envelopes.
</ParamField>

<ParamField path="redirects" type="object">
  Redirect URLs for post-session navigation.

  <Expandable title="child arguments">
    <ResponseField name="session_completed" type="string">
      Redirect after the recipient completes the envelope.
    </ResponseField>

    <ResponseField name="session_declined" type="string">
      Redirect after the recipient declines the envelope.
    </ResponseField>
  </Expandable>
</ParamField>

<RequestExample>
  ```bash Endpoint theme={null}
  PUT /v1/recipients/255e591c2c9fe1bc99be1ec03075b402
  ```

  ```bash Body theme={null}
  {
    "name": "Ted Annature",
    "email": "ted@annature.com.au",
    "mobile": "+61422000000",
    "type": "signer",
    "message": "Updated message",
    "password": "new-password",
    "sms_auth": true,
    "muted": false,
    "order": 1,
    "redirects": {
      "session_completed": "https://example.com/completed",
      "session_declined": "https://example.com/declined"
    }
  }
  ```
</RequestExample>

<ResponseExample>
  ```json theme={null}
  {
    "id": "255e591c2c9fe1bc99be1ec03075b402",
    "name": "Ted Annature",
    "email": "ted@annature.com.au",
    "mobile": "+61422000000",
    "type": "signer",
    "status": "sent",
    "message": "Updated message",
    "password": true,
    "sms_auth": true,
    "muted": false,
    "order": 1,
    "declined_reason": null,
    "created": "2019-12-17T05:30:00Z",
    "sent": "2019-12-17T05:30:00Z",
    "declined": null,
    "completed": null,
    "redirects": {
      "session_completed": "https://example.com/completed",
      "session_declined": "https://example.com/declined"
    }
  }
  ```
</ResponseExample>