Update recipient

post https://secure.finch-app.com/api/public/v1/file/{reference}/recipient/{recipientId}/update-email

Updates the name and email address of the given recipient.

Permissions

The following permissions are required to call this API. Learn more.

Permission type	Permissions
API key action permission	File
Folder access control list permission	Sender

Remarks

Recipients may only be updated when the file is at status "pending" (i.e. out for completion).

Recipients may not be updated when:

The recipient is a signatory, and they have already electronically signed a document

Responses

204

Successfully processed

xxxxxxxxxx
curl --request POST \
     --url https://secure.finch-app.com/api/public/v1/file/reference/recipient/recipientId/update-email \
     --header 'accept: application/json' \
     --header 'content-type: application/json'

400HTTP 400 Bad Request - Badly formed request

404HTTP 404 Not Found

422HTTP 422 Unprocessable Entity - Well formed request but unprocessable

500HTTP 500 Internal Server Error - Unexpected server error