---
title: "Update record"
method: PATCH
path: "/orgs/records/{record_id}"
tags: ["Records"]
---

# Update record

`PATCH /orgs/records/{record_id}`

## Request

- Base URL: `https://api.useinvent.com`
- URL: `https://api.useinvent.com/orgs/records/{record_id}`
- Auth: HTTP bearer

Update record values and/or archived flag.

## Path parameters

- `record_id` string, required

## Request body

- UpdateTableRecordSchema
  - `values` SetTableRecordValuesSchema: Map of field key → value. Multi-value fields accept arrays; pass null or [] to clear.
  - `icon` union
    - string, emoji: The emoji of a curated icon a user can pick for a table, view, field, or other entity
    - 'TableCellsIcon' | 'DatabaseIcon' | 'DocumentTextIcon' | 'DocumentChartBarIcon' | 'ClipboardDocumentListIcon' | 'ClipboardDocumentCheckIcon' | 'FolderIcon' | 'ArchiveBoxIcon' | 'InboxIcon' | 'BookOpenIcon' | 'BookmarkIcon' | 'NewspaperIcon' | 'RectangleStackIcon' | 'PencilSquareIcon' | 'UserIcon' | 'UsersIcon' | 'UserGroupIcon' | 'UserPlusIcon' | 'IdentificationIcon' | 'FaceSmileIcon' | 'HandThumbUpIcon' | 'HeartIcon' | 'StarIcon' | 'CheckBadgeIcon' | 'TrophyIcon' | 'CrownIcon' | 'ChatBubbleLeftIcon' | 'ChatBubbleLeftRightIcon' | 'EnvelopeIcon' | 'EnvelopeOpenIcon' | 'PhoneIcon' | 'DevicePhoneMobileIcon' | 'MegaphoneIcon' | 'BellIcon' | 'PaperAirplaneIcon' | 'AtSymbolIcon' | 'RssIcon' | 'LifebuoyIcon' | 'ShoppingCartIcon' | 'ShoppingBagIcon' | 'BuildingStorefrontIcon' | 'CreditCardIcon' | 'BanknotesIcon' | 'CurrencyDollarIcon' | 'CurrencyEuroIcon' | 'ReceiptPercentIcon' | 'WalletIcon' | 'CoinsIcon' | 'GiftIcon' | 'TagIcon' | 'TicketIcon' | 'ScaleIcon' | 'TruckIcon' | 'CubeIcon' | 'CalendarIcon' | 'CalendarDaysIcon' | 'CalendarDateRangeIcon' | 'ClockIcon' | 'FlagIcon' | 'CheckCircleIcon' | 'ListBulletIcon' | 'QueueListIcon' | 'FunnelIcon' | 'ChartBarIcon' | 'ChartPieIcon' | 'PresentationChartLineIcon' | 'ArrowTrendingUpIcon' | 'BriefcaseIcon' | 'WrenchScrewdriverIcon' | 'Cog6ToothIcon' | 'KeyIcon' | 'LockClosedIcon' | 'ShieldCheckIcon' | 'BoltIcon' | 'LightBulbIcon' | 'BeakerIcon' | 'BugAntIcon' | 'CpuChipIcon' | 'CodeBracketIcon' | 'CommandLineIcon' | 'ServerIcon' | 'LinkIcon' | 'HomeIcon' | 'HomeModernIcon' | 'BuildingOfficeIcon' | 'BuildingOffice2Icon' | 'BuildingLibraryIcon' | 'MapPinIcon' | 'MapIcon' | 'GlobeAltIcon' | 'GlobeAmericasIcon' | 'RocketLaunchIcon' | 'PlaneIcon' | 'CarIcon' | 'SunIcon' | 'MoonIcon' | 'FireIcon' | 'SparklesIcon' | 'CakeIcon' | 'AcademicCapIcon' | 'ScissorsIcon' | 'SwatchIcon' | 'PaintBrushIcon' | 'CoffeeIcon' | 'UtensilsIcon' | 'LeafIcon' | 'DumbbellIcon' | 'HeartPulseIcon' | 'PawPrintIcon' | 'StethoscopeIcon' | 'CameraIcon' | 'PhotoIcon' | 'FilmIcon' | 'VideoCameraIcon' | 'MicrophoneIcon' | 'MusicalNoteIcon' | 'SpeakerWaveIcon' | 'PlayCircleIcon' | 'TvIcon' | 'RadioIcon' | 'PuzzlePieceIcon' | 'GamepadIcon': The name of a curated icon a user can pick for a table, view, field, or other entity
  - `archived` boolean: Move the record to the trash (true) or restore it (false); trashed records are hidden from default searches.

## Response `200`

- TableRecordSchema
  - `id` string, required
  - `table_id` string, required
  - `icon` union, required: The picked icon. Null falls back to the table icon.
    - string, emoji: The emoji of a curated icon a user can pick for a table, view, field, or other entity
    - 'TableCellsIcon' | 'DatabaseIcon' | 'DocumentTextIcon' | 'DocumentChartBarIcon' | 'ClipboardDocumentListIcon' | 'ClipboardDocumentCheckIcon' | 'FolderIcon' | 'ArchiveBoxIcon' | 'InboxIcon' | 'BookOpenIcon' | 'BookmarkIcon' | 'NewspaperIcon' | 'RectangleStackIcon' | 'PencilSquareIcon' | 'UserIcon' | 'UsersIcon' | 'UserGroupIcon' | 'UserPlusIcon' | 'IdentificationIcon' | 'FaceSmileIcon' | 'HandThumbUpIcon' | 'HeartIcon' | 'StarIcon' | 'CheckBadgeIcon' | 'TrophyIcon' | 'CrownIcon' | 'ChatBubbleLeftIcon' | 'ChatBubbleLeftRightIcon' | 'EnvelopeIcon' | 'EnvelopeOpenIcon' | 'PhoneIcon' | 'DevicePhoneMobileIcon' | 'MegaphoneIcon' | 'BellIcon' | 'PaperAirplaneIcon' | 'AtSymbolIcon' | 'RssIcon' | 'LifebuoyIcon' | 'ShoppingCartIcon' | 'ShoppingBagIcon' | 'BuildingStorefrontIcon' | 'CreditCardIcon' | 'BanknotesIcon' | 'CurrencyDollarIcon' | 'CurrencyEuroIcon' | 'ReceiptPercentIcon' | 'WalletIcon' | 'CoinsIcon' | 'GiftIcon' | 'TagIcon' | 'TicketIcon' | 'ScaleIcon' | 'TruckIcon' | 'CubeIcon' | 'CalendarIcon' | 'CalendarDaysIcon' | 'CalendarDateRangeIcon' | 'ClockIcon' | 'FlagIcon' | 'CheckCircleIcon' | 'ListBulletIcon' | 'QueueListIcon' | 'FunnelIcon' | 'ChartBarIcon' | 'ChartPieIcon' | 'PresentationChartLineIcon' | 'ArrowTrendingUpIcon' | 'BriefcaseIcon' | 'WrenchScrewdriverIcon' | 'Cog6ToothIcon' | 'KeyIcon' | 'LockClosedIcon' | 'ShieldCheckIcon' | 'BoltIcon' | 'LightBulbIcon' | 'BeakerIcon' | 'BugAntIcon' | 'CpuChipIcon' | 'CodeBracketIcon' | 'CommandLineIcon' | 'ServerIcon' | 'LinkIcon' | 'HomeIcon' | 'HomeModernIcon' | 'BuildingOfficeIcon' | 'BuildingOffice2Icon' | 'BuildingLibraryIcon' | 'MapPinIcon' | 'MapIcon' | 'GlobeAltIcon' | 'GlobeAmericasIcon' | 'RocketLaunchIcon' | 'PlaneIcon' | 'CarIcon' | 'SunIcon' | 'MoonIcon' | 'FireIcon' | 'SparklesIcon' | 'CakeIcon' | 'AcademicCapIcon' | 'ScissorsIcon' | 'SwatchIcon' | 'PaintBrushIcon' | 'CoffeeIcon' | 'UtensilsIcon' | 'LeafIcon' | 'DumbbellIcon' | 'HeartPulseIcon' | 'PawPrintIcon' | 'StethoscopeIcon' | 'CameraIcon' | 'PhotoIcon' | 'FilmIcon' | 'VideoCameraIcon' | 'MicrophoneIcon' | 'MusicalNoteIcon' | 'SpeakerWaveIcon' | 'PlayCircleIcon' | 'TvIcon' | 'RadioIcon' | 'PuzzlePieceIcon' | 'GamepadIcon': The name of a curated icon a user can pick for a table, view, field, or other entity
  - `archived` boolean, required: Whether the record is archived.
  - `position` string, nullable, required: The position of the record in the view.
  - `updated_at` string, date-time, nullable, required: Last modification time. Total-orders concurrent updates so caches can keep the newest copy.
  - `values` TableRecordValueSchema[], required: The values of the record.
    - union
      - TableRecordValueStringSchema
        - `id` string, required
        - `key` string, required
        - `type` 'string', required
        - `value` string, required
      - TableRecordValueNumberSchema
        - `id` string, required
        - `key` string, required
        - `type` 'number', required
        - `value` number, required
      - TableRecordValueBooleanSchema
        - `id` string, required
        - `key` string, required
        - `type` 'boolean', required
        - `value` boolean, required
      - TableRecordValueDateSchema
        - `id` string, required
        - `key` string, required
        - `type` 'date', required
        - `value` union, required
          - string, date-time, nullable
          - string[]
      - TableRecordValueDatetimeSchema
        - `id` string, required
        - `key` string, required
        - `type` 'datetime', required
        - `value` union, required
          - string, date-time, nullable
          - string[]
      - TableRecordValueEnumSchema
        - `id` string, required
        - `key` string, required
        - `type` 'enum', required
        - `value` union, required
          - string
          - string[]
      - TableRecordValueFileSchema
        - `id` string, required
        - `key` string, required
        - `type` 'file', required
        - `value` union, required
          - string
          - string[]
        - `display` union
          - FileSchema: Detailed information about a file
            - `id` string, required: Unique identifier for the file
            - `file_path` string, required: Path to the file in the storage system
            - `file_filename` string, required: Name of the file
            - `file_size` number, required: Size of the file in bytes
            - `file_mimetype` string, required: MIME type of the file
            - `file_url` string, required: URL to access the file
            - `created_at` string, date-time, nullable, required: Timestamp when the file was created
          - FileSchema[]
            - `id` string, required: Unique identifier for the file
            - `file_path` string, required: Path to the file in the storage system
            - `file_filename` string, required: Name of the file
            - `file_size` number, required: Size of the file in bytes
            - `file_mimetype` string, required: MIME type of the file
            - `file_url` string, required: URL to access the file
            - `created_at` string, date-time, nullable, required: Timestamp when the file was created
      - TableRecordValueRecordSchema
        - `id` string, required
        - `key` string, required
        - `type` 'record', required
        - `value` union, required
          - string
          - string[]
        - `display` union
          - TableRecordLimitedSchema: Compact reference to a record from another table, used when one record points at another via a `record`-typed field.
            - `id` string, required
            - `table_id` string, required
            - `display` TableRecordValueSchema, required (recursive)
          - TableRecordLimitedSchema[]
            - `id` string, required
            - `table_id` string, required
            - `display` TableRecordValueSchema, required (recursive)
      - TableRecordValueContactSchema
        - `id` string, required
        - `key` string, required
        - `type` 'contact', required
        - `value` union, required
          - string
          - string[]
        - `display` union
          - ContactSchema: Schema for the contact
            - `id` string, required
            - `name` string, nullable, required
            - `blocked` boolean, required
            - `blocked_at` string, date-time
            - `unsubscribed` boolean, required
            - `unsubscribed_at` string, date-time
            - `unsubscribe_reason` string
            - `unsubscribe_feedback` string
            - `ai_replies` boolean, required
            - `ai_replies_at` string, date-time
            - `is_admin` boolean, required
            - `channels` ContactChannelSchema[], required
              - …
            - `segments` SegmentLimitedSchema[], required
              - …
            - `fields` object, required: Map of contact field key → value.
            - `created_at` string, date-time, required
            - `updated_at` string, date-time, required
          - ContactSchema[]
            - `id` string, required
            - `name` string, nullable, required
            - `blocked` boolean, required
            - `blocked_at` string, date-time
            - `unsubscribed` boolean, required
            - `unsubscribed_at` string, date-time
            - `unsubscribe_reason` string
            - `unsubscribe_feedback` string
            - `ai_replies` boolean, required
            - `ai_replies_at` string, date-time
            - `is_admin` boolean, required
            - `channels` ContactChannelSchema[], required
              - …
            - `segments` SegmentLimitedSchema[], required
              - …
            - `fields` object, required: Map of contact field key → value.
            - `created_at` string, date-time, required
            - `updated_at` string, date-time, required
      - TableRecordValueUserSchema
        - `id` string, required
        - `key` string, required
        - `type` 'user', required
        - `value` union, required
          - string
          - string[]
        - `display` union
          - object: Schema for a limited user
            - `id` string, required
            - `name` string, nullable, required
            - `email` string, email, required
            - `avatar` string, nullable, required
            - `seen_at` string, date-time, nullable, required
          - object[]
            - `id` string, required
            - `name` string, nullable, required
            - `email` string, email, required
            - `avatar` string, nullable, required
            - `seen_at` string, date-time, nullable, required
      - TableRecordValueChatSchema
        - `id` string, required
        - `key` string, required
        - `type` 'chat', required
        - `value` union, required
          - string
          - string[]
        - `display` union
          - object: Compact chat reference for embedding in other resources (table value display, ref cells, etc.). Carries the minimum the FE needs to render a chat chip: title, status indicator, state subset (ai_enabled, muted, follow-up, unseen), and created date.
            - `id` string, required
            - `title` string, nullable, required
            - `status` 'RUNNING' | 'COMPLETED' | 'FAILED' | 'CANCELED', required
            - `state` ChatLimitedStateSchema
              - …
            - `created_at` string, date-time, nullable, required
          - object[]
            - `id` string, required
            - `title` string, nullable, required
            - `status` 'RUNNING' | 'COMPLETED' | 'FAILED' | 'CANCELED', required
            - `state` ChatLimitedStateSchema
              - …
            - `created_at` string, date-time, nullable, required
      - TableRecordValueSegmentSchema
        - `id` string, required
        - `key` string, required
        - `type` 'segment', required
        - `value` union, required
          - string
          - string[]
        - `display` union
          - SegmentLimitedSchema: Schema for the segment
            - `id` string, required
            - `name` string, required
            - `color` 'red' | 'orange' | 'amber' | 'yellow' | 'lime' | 'green' | 'teal' | 'cyan' | 'sky' | 'blue' | 'indigo' | 'violet' | 'purple' | 'fuchsia' | 'pink' | 'rose' | 'neutral', required: Accent color, by name
            - `contacts_count` number, required
            - `created_at` string, date-time, required
            - `updated_at` string, date-time, required
          - SegmentLimitedSchema[]
            - `id` string, required
            - `name` string, required
            - `color` 'red' | 'orange' | 'amber' | 'yellow' | 'lime' | 'green' | 'teal' | 'cyan' | 'sky' | 'blue' | 'indigo' | 'violet' | 'purple' | 'fuchsia' | 'pink' | 'rose' | 'neutral', required: Accent color, by name
            - `contacts_count` number, required
            - `created_at` string, date-time, required
            - `updated_at` string, date-time, required
      - TableRecordValueAssistantSchema
        - `id` string, required
        - `key` string, required
        - `type` 'assistant', required
        - `value` union, required
          - string
          - string[]
        - `display` union
          - object: Compact assistant reference for embedding in other resources (table value display, ref cells, etc.). `deleted` lets the FE render soft-deleted assistants as non-clickable while still showing the name and avatar.
            - `id` string, required
            - `name` string, required
            - `avatar_url` string, nullable, required
            - `deleted` boolean, required
            - `created_at` string, date-time, nullable, required
            - `updated_at` string, date-time, nullable, required
          - object[]
            - `id` string, required
            - `name` string, required
            - `avatar_url` string, nullable, required
            - `deleted` boolean, required
            - `created_at` string, date-time, nullable, required
            - `updated_at` string, date-time, nullable, required
      - TableRecordValueAgentSchema
        - `id` string, required
        - `key` string, required
        - `type` 'agent', required
        - `value` union, required
          - string
          - string[]
        - `display` union
          - AgentLimitedSchema: A reduced agent reference
            - `id` string, required
            - `name` string, required
            - `icon` union, required: A picked icon or emoji. Null = the generated face, unless a custom image is set.
              - …
            - `color` 'red' | 'orange' | 'amber' | 'yellow' | 'lime' | 'green' | 'teal' | 'cyan' | 'sky' | 'blue' | 'indigo' | 'violet' | 'purple' | 'fuchsia' | 'pink' | 'rose' | 'neutral', required: The identity color, reused by every surface that carries the agent
            - `shape` 'square' | 'round' | 'pebble' | 'slate' | 'beam' | 'bloom' | 'arch' | 'clave', required: The silhouette of a generated agent face
            - `avatar_url` string, nullable, required: The agent as an image, either the custom picture or the PNG snapshot of its face or icon
          - AgentLimitedSchema[]
            - `id` string, required
            - `name` string, required
            - `icon` union, required: A picked icon or emoji. Null = the generated face, unless a custom image is set.
              - …
            - `color` 'red' | 'orange' | 'amber' | 'yellow' | 'lime' | 'green' | 'teal' | 'cyan' | 'sky' | 'blue' | 'indigo' | 'violet' | 'purple' | 'fuchsia' | 'pink' | 'rose' | 'neutral', required: The identity color, reused by every surface that carries the agent
            - `shape` 'square' | 'round' | 'pebble' | 'slate' | 'beam' | 'bloom' | 'arch' | 'clave', required: The silhouette of a generated agent face
            - `avatar_url` string, nullable, required: The agent as an image, either the custom picture or the PNG snapshot of its face or icon

---

[API](https://skmtc.dev/useinvent/apis/invent-api.md) · [All operations](https://skmtc.dev/useinvent/apis/invent-api/llms.txt) · [OpenAPI document](https://skmtc.dev/useinvent/apis/invent-api/revisions/98824f3fde82?raw)
