API Reference

Add recipient(s)

post
https://secure.finch-app.com/api/public/v1/file//recipient

Adds the given recipient(s) to a file.

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 added when the file is at status "pending" (i.e. out for completion).

Recipients may not be added when:

  • They are a duplicate of a recipient in the file already
  • Adding the recipient would exceed the maximum number of recipients allowed in a group
  • The workflow has already progressed in its signing order (routing order) past the point where the recipient could contribute/sign. Consider re-issuing in this case.
Path Params
string | null
required
Body Params

A request to add the given recipients to a file

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.

recipients
array of objects
required
length ≥ 1

A collection of recipients to be added who will be sent the workflow to complete.

recipients*
string | null

Optional. Supports markdown. The invitation body message to be communicated to the new recipient. If not specified, and this new recipient is amongst the first in the sign ordering, uses the original invitation body message where provided.

Responses

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