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.
Language
Credentials
Bearer
JWT
URL
Click Try It! to start a request and see the response here!