API Reference

Update recipient

post
https://secure.finch-app.com/api/public/v1/file//recipient//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 typePermissions
API key action permissionFile
Folder access control list permissionSender

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
Path Params
string | null
required
string | null
required
Body Params
uuid | null

An optional unique request ID (uuid) for resiliance and debugging purposes. Send any properly generated new uuid. If one is not provided (not recommended), a new request ID will be generated for you.

string
required
length ≥ 1

The name to be specified for the recipient

string
required
length ≥ 1

The email address to be specified for the recipient

boolean | null

Optional. Defaults to true. Set to true to send an invitation email to the new email address, or false otherwise.

string | null

Optional. Supports markdown. The invitation body message to be communicated to the new recipient. If not specified, uses the original invitation body message where provided.

Responses
204

Successfully processed

Updated over 1 year ago

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 1 year ago