API Reference

Cancel a file

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

Cancels a file in the Finch vault and informs signatories, if there are any.

Permissions

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

Permission typePermissions
API key action permissionFile
Folder access control list permission for files created by your applicationUser
Folder access control list permission for files created by other usersApprover
Path Params
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

A plain-text message that will be relayed to the end customer as to why the file is being cancelled.

Responses
204

Successfully processed

Updated almost 3 years 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 almost 3 years ago