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

Modify recipient's personal details.

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

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

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"

Request body fields

Name	Type	Required	Description
`job_title`	String	No
`first_name`	String	No
`postal_code`	String	No
`state`	String	No
`verification_settings`	Object	No	To set up recipient verification, fill in verification_place and specify the type: passcode_verification, phone_verification, kba_verification or id_verification. For passcode_verification, provide the passcode. For phone_verification, provide the phone_number. For kba_verification and id_verification, set the enabled parameter to true.
`verification_settings.phone_verification`	Object	No	Sets the phone number to send a passcode to.
`verification_settings.phone_verification.phone_number`	String	Yes	A phone number to send a passcode to.
`verification_settings.kba_verification`	Object	No	Sets the KBA verification.
`verification_settings.kba_verification.max_attempts_count`	Integer	No
`verification_settings.kba_verification.time_limit_sec`	Integer	No
`verification_settings.kba_verification.score_threshold`	Integer	No
`verification_settings.id_verification`	Object	No	Sets the ID verification.
`verification_settings.id_verification.enabled`	Boolean	No
`verification_settings.verification_place`	String	No	Specifies when a recipient must complete the verification process: `before_open` (before opening the document), `before_sign` (before signing the document). Valid values: `"before_open"` `"before_sign"`
`verification_settings.passcode_verification`	Object	No	Sets the passcode.
`verification_settings.passcode_verification.passcode`	String	Yes	Document passcode.
`redirect`	Object	No
`redirect.url`	String	Yes	A URL to redirect to after the document is signed.
`redirect.is_enabled`	Boolean	Yes	Default value: false
`city`	String	No
`email`	String	No	You cannot use the email of another contact when updating a recipient contact.
`last_name`	String	No
`street_address`	String	No
`company`	String	No
`phone`	String	No
`delivery_methods`	Object	No
`delivery_methods.email`	Boolean	No
`delivery_methods.sms`	Boolean	No

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.