Book a demo

delete_file

Delete a file

act entity tenant-private since 2026-10-01

Deletes one of the org's files. It stops being listed or read at once, and its bytes are kept aside for 30 days before they are gone.

Contract

shape
entity
authority
act
evidence
none
subscription
false
permission
any one of: org.admin (carried by the caller's role template in the org `org_id`); a deactivated caller is refused first
idempotency
natural
emits
file.deleted
MCP tool
delete_file
decision_set
approve, reject
REST
POST https://api.containertradehq.com/v1/cap/delete_file

Through MCP this call returns an approval request first; see Approvals.

Idempotency: keyed by the contract's own inputs: the same inputs replay the first call's result

Inputs

nametyperequiredvalidation
org_idorg_idrequiredtradehq-org-id; 1 to 20 characters
The org the file is filed in.
file_idtextrequired26 to 26 characters
The file's id.

Response

  • file_id · string · The file.
  • org_id · string · The org it was filed in.
  • state · string · deleted.
  • deleted_at · string · When it was deleted.
Full JSON Schema 
{
  "type": "object",
  "properties": {
    "file_id": {
      "type": "string",
      "description": "The file.",
      "x-data-class": "operational"
    },
    "org_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 20,
      "pattern": "^[A-Za-z0-9_-]{1,20}$",
      "format": "tradehq-org-id",
      "description": "The org it was filed in.",
      "x-data-class": "operational"
    },
    "state": {
      "type": "string",
      "enum": [
        "deleted"
      ],
      "description": "deleted.",
      "x-data-class": "operational"
    },
    "deleted_at": {
      "type": "string",
      "format": "date-time",
      "description": "When it was deleted.",
      "x-data-class": "operational"
    }
  },
  "required": [
    "file_id",
    "org_id",
    "state",
    "deleted_at"
  ],
  "additionalProperties": false
}

Refusals

  • files_unavailable · 422 · this deployment has no intake or files store configured yet

The platform refusals apply to every call: version, authentication, authority, validation and rate limits, each in the same envelope.

Surfaces

DesktopF
MobileF
APIF
MCPF*
VoiceN
PushF
OneBoxN
OutboundN
  • MCP: approval required
  • Voice: a voice surface deletes no file
  • OneBox: no document originates a deletion
  • Outbound: crosses to no counterparty

Events

Related

get_file