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 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.

Servers

https://api.pandadoc.com

Path parameters

Name	Type	Required	Description
`id`	String	Yes	Document UUID.
`recipient_id`	String	Yes	Recipient UUID.

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.