Delete file

Permanently delete a file and its stored contents. This is the only way to detach a file from the record it belongs to — leaving a file out of a files array on a later update does not remove it. Files the platform manages itself are locked and cannot be deleted, and deleting a file that no longer exists succeeds without doing anything. The required permission depends on the file's link type: person files require Write Files; business files require Limited Write Contributions or Full Write Accounting; batch and transaction_file files require Limited Write Contributions; bank_reconciliation and journal_entry files require Full Write Accounting; safeguard files require Write Safeguards; sermon files require Full Write Sermons; and group files require being an administrator of the group or a member granted file access.

Required permission: Write Files or Limited Write Contributions or Full Write Accounting or Full Write Sermons or Write Safeguards

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required
≥ 1

The id of the file to delete

Responses
200

OK

401

Authentication is required, or the Ocs-Api-Key header is missing or invalid.

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here!