---
title: "Update Document Recipient"
method: PATCH
path: "/public/v1/documents/{id}/recipients/recipient/{recipient_id}"
tags: ["Document Recipients"]
---

# Update Document Recipient

`PATCH /public/v1/documents/{id}/recipients/recipient/{recipient_id}`

Modify a recipient's personal details, or update a recipient group's name and members.

> 🚧 Before you start
> 
> To edit a recipient, please ensure that you have the 'Can Edit Document' permission.

Use this endpoint to easily fix typos in a recipient's name or email, or to change any other recipient information in a sent document. 

### Editing a recipient group

When the `recipient_id` points to a recipient group, you can rename the group and/or change its members:

- Send `name` to rename the group.
- Send `members` to replace the group's membership. The list you send becomes the group's new full membership: members you omit are removed, and new entries are added. Members are matched by `email`; for a retained member, only the contact fields you include (`first_name`, `last_name`) are updated, and omitted fields keep their existing values.
- At least one of `name` or `members` must be provided, and `members` (when sent) must contain at least one member.

On a sent document, newly added members are notified and receive their access link, while removed members lose access.

Both individual recipient and recipient group edits return `204 No Content`.

> 📘 Please note that changes made to a recipient within a document will also update their `Contact` information. However, these changes will not update information about this recipient in other documents where they have already been added.

### Document status

- You can edit a signer in the following document statuses:
  - 'Draft' (`document.draft`),
  - 'Waiting Approval' (`document.waiting_approval`),
  - 'Approved' (`document.approved`),
  - 'Rejected' (`document.rejected`),
  - 'Sent' (`document.sent`),
  - 'Viewed' (`document.viewed`), but only until they have signed the document.
- You can edit a CC recipient in any document status **except**:
  - 'Expired' (`document.voided`),
  - 'Declined' (`document.declined`).

> 📘 Updating a recipient's email after sending a document
> 
> **Note**: If you update a recipient's email address after sending a document, they will receive an instant notification at the new email address, allowing them access to the document. Access via the previous email will be revoked.

### Restrictions for updating a recipient's email

- You cannot change emails of PandaDoc users.
- You cannot use the email addresses of existing contacts. If you need to use an email from an existing contact, use the [Change Signer](https://developers.pandadoc.com/reference/change-signer) endpoint to replace a signer with this contact.

### Recipient communication preferences

PandaDoc honors recipient opt-outs when re-notifying a recipient on a sent document. The request will return `400 Bad Request` in the following cases:

- **Email** — when changing a recipient's email or enabling email delivery, if the new email address has been marked as opted-out for your organization (for example, the recipient previously reported a PandaDoc email from your organization as spam).
- **SMS** — when changing a recipient's phone number or enabling SMS delivery, if the recipient has opted out of receiving SMS messages (for example, by replying STOP).

To remove a recipient from the opt-out list, contact PandaDoc Support.

## Path parameters

- `id` string, required
- `recipient_id` string, required

## Request body

- union
  - DocumentRecipientEditRequest
    - `email` string, nullable — You cannot use the email of another contact when updating a recipient contact.
    - `phone` string, nullable
    - `delivery_methods` RecipientDeliveryMethods, nullable
      - `email` boolean
      - `sms` boolean
    - `first_name` string, nullable
    - `last_name` string, nullable
    - `company` string, nullable
    - `title` string, nullable
    - `state` string, nullable
    - `street_address` string, nullable
    - `city` string, nullable
    - `postal_code` string, nullable
    - `country` string, nullable
    - `verification_settings` RecipientVerificationSettings — To set up recipient verification, provide verification_place (required) and exactly one verification type: passcode_verification, phone_verification, kba_verification, id_verification, or email_otp_verification. All other verification type fields must be null. Providing more than one verification type returns a 400 error. - For passcode_verification, provide the passcode. - For phone_verification, provide the phone_number. - For email_otp_verification, provide the email. - For kba_verification and id_verification, set the enabled parameter to true.
      - `verification_place` 'before_open' | 'before_sign' — Specifies when a recipient must complete the verification process: - `before_open` (before opening the document), - `before_sign` (before signing the document).
      - `passcode_verification` object, nullable — Sets the passcode.
        - `passcode` string, required — Document passcode.
      - `phone_verification` object, nullable — Sets the phone number to send a passcode to.
        - `phone_number` string, required — A phone number to send a passcode to.
      - `kba_verification` object, nullable — Sets the KBA verification.
        - `time_limit_sec` integer
        - `score_threshold` integer
        - `max_attempts_count` integer
      - `id_verification` object, nullable — Sets the ID verification.
        - `enabled` boolean
      - `email_otp_verification` object, nullable — Sets the email address to send a one-time passcode to.
        - `email` string, email, required — An email address to send a one-time passcode to.
    - `redirect` RecipientRedirect
      - `is_enabled` boolean, required
      - `url` string, nullable, required — A URL to redirect to after the document is signed.
  - DocumentRecipientGroupEditRequest — Update a recipient group's name and/or its members. Provide at least one of `name` or `members`. When `members` is sent, it **replaces** the group's current membership: members not present in the list are removed from the group, and any new members are added. On a sent document, newly added members are notified and removed members lose access. Members are matched by `email`; for a retained member, only the contact fields you include (`first_name`, `last_name`) are updated, and omitted fields keep their existing values.
    - `name` string — New name for the recipient group.
    - `members` DocumentRecipientGroupEditMember[] — The full list of members the group should contain after the update. Must contain at least one member when provided.
      - `email` string, required — The member's email address. Required: it identifies the member when diffing the group's membership.
      - `first_name` string, nullable — The member's first name.
      - `last_name` string, nullable — The member's last name.

## Response `204`

No content.

## Other responses

- `400` — Bad Request
- `401` — Authentication error
- `403` — Permission error
- `404` — Not found
- `423` — Document is locked for editing
- `429` — Too Many Requests

---

[API](https://skmtc.net/pandadoc/apis/pandadoc-public-api.md) · [All operations](https://skmtc.net/pandadoc/apis/pandadoc-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pandadoc/pandadoc-public-api/versions/0c2b70be3fb0/schema)