File attachments
A file linked to one business item in one module.
- API name:
fileattachments - Domain: Features
- Modules: Sales analytics, Finance analytics, Inventory analytics, Manufacturing analytics, Purchasing analytics, Sales, Stores, Services, Finances, Inventory, Manufacturing, Purchasing, Logistics, Human resources, Employee portal, Point of sale, Site operations, My workspace, Master data, Directory, Administration
Fields
The API name is what the API, MCP and the CLI use.
| Name | API name | Type | Required | Description |
|---|---|---|---|---|
| ID | id | Record ID | Yes | |
| File | fileId | Reference | Yes | |
| Record | tableUid | Constant | Yes | Business table this row points to. |
| Record ID | recordId | Text | Yes | |
| Role | role | Constant | Fixed option from the allowed set for this field. | |
| Audiences | audiences | Constant | Yes | Who may open the link when the file is public on this attachment. |
| Shareable link | isPublic | Boolean | Yes | Organization members only by default; anyone with the link when shareable. |
| Created by | createdBy | User | ||
| Created at | createdAt | Date and Time | Yes | |
| Updated by | updatedBy | User | ||
| Updated at | updatedAt | Date and Time | Yes | |
| Blocked by | blockedBy | User | ||
| Blocked at | blockedAt | Date and Time | ||
| Archived by | archivedBy | User | ||
| Archived at | archivedAt | Date and Time |
Relations
| Field | Points to | Kind |
|---|---|---|
File fileId | Files | reference |
Actions
What you can do with a record. Every action also sends the webhook event fileattachments.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add a new file attachment. | App · API · MCP · CLI |
| Edit | update | Save changes to this file attachment. | App · API · MCP · CLI |
| Attach file | attach | Link an existing file to this file attachment. | App · API · MCP · CLI |
| Detach file | detach | Remove the file from this file attachment without deleting the file. | App · API · MCP · CLI |
| Replace file | replace | Swap the linked file for another one. | App · API · MCP · CLI |
| Block | block | Stop edits and deletion of this file attachment. It stays visible and can still appear on existing documents. Unblock to edit again. | App · API · MCP · CLI |
| Unblock | unblock | Allow edits and deletion of this file attachment again. | App · API · MCP · CLI |
| Archive | archive | Retire this file attachment from daily use. It leaves active lists and pickers, and most actions stop. Unarchive to restore it. | App · API · MCP · CLI |
| Restore | unarchive | Return this file attachment to active lists and actions. | App · API · MCP · CLI |
| Delete | delete | Delete this file attachment and the data that belongs with it. This cannot be undone. | App · API · MCP · CLI |