Login
Free Sign Up
Docs
/

Object - Update

Type identifier: object:update Category: Object Operations

Description

Updates an existing Record with new values, modifying only the specified properties and preserving unchanged data. Handles file uploads automatically when properties contain files.

Input Handles

Handle

Data Type

Required

Description

trigger

trigger

Yes

Initiates the update operation

id

string

Yes

Record ID to update

<propertyPath>

Varies

Varies

One handle per selected property

Input Handle Details

id

  • Type: string (CUID2 format)
  • Notes:

    • Can receive a string ID directly
    • Can receive an object with an id property (extracts the ID)
    • Must reference an existing Record

Property Handles

Input handles are dynamically generated based on selectedProperties:

  • Handle ID: Dot-notation path to the property (for example, name, address.city)
  • Type: Defined by the Schema's property type
  • Notes: Only selected properties are updated; other fields remain unchanged

Output Handles

Handle

Data Type

Description

success

trigger

Triggered when update succeeds

error

trigger

Triggered on any error

object

object

The updated Record with metadata

Output Handle Details

object

  • Type: Object matching the Schema, plus metadata
  • Includes:

    • All Record properties (updated values)
    • id: Record ID
    • schemaId: Schema ID
    • createdAt: Original creation timestamp
    • createdById: Original creator ID
    • updatedAt: Update timestamp
    • updatedById: Current user or Flow ID

Configuration Options

Property

Type

Required

Default

Description

label

string

Yes

"Object - Update"

Display label for the node

schemaId

string

Yes

""

CUID2 of the Schema to update

selectedProperties

string[][]

Yes

[]

Paths to properties to update

Configuration Details

schemaId

  • Type: string (CUID2)
  • Notes:

    • Must reference a valid Schema in the Space
    • Schema determines available properties

selectedProperties

  • Type: string[][] (array of path arrays)
  • Format: Each inner array represents a property path
  • Notes:

    • Only properties in this list are updated
    • Creates corresponding input handles
    • Supports nested property paths

Behaviour

Property Update Mechanics

Operation

Behaviour

Modify property

Replaces value at path

Set to null

Clears the property value

Nested property

Updates specific nested field only

File Handling

Files in updated properties are uploaded when the update runs. Existing files from the same Record are preserved, and files from the Flow run are re-uploaded to the Record.

Error Handling

For selected-property inputs, Schema validation reports all invalid values together. The failure includes each property path and issue code, plus the expected type when available; the run inspector displays these without input values.

Scenario

Behaviour

Schema not found

Triggers error

Record ID missing

Triggers error

Invalid Record ID format

Triggers error

Record not found

Triggers error

Invalid data for the Schema

Triggers error

Database update fails

Triggers error

Examples

Basic Property Update

{
  "type": "object:update",
  "data": {
    "label": "Update User Status",
    "schemaId": "user-schema-uuid",
    "selectedProperties": [["status"], ["lastLoginAt"]]
  }
}

Updates only status and lastLoginAt fields on the user Record.

Nested Property Update

{
  "type": "object:update",
  "data": {
    "label": "Update Address",
    "schemaId": "contact-schema-uuid",
    "selectedProperties": [
      ["address", "street"],
      ["address", "city"],
      ["address", "zipCode"]
    ]
  }
}

Updates specific address fields while preserving other Record data.

Update With File Upload

{
  "type": "object:update",
  "data": {
    "label": "Update Document",
    "schemaId": "document-schema-uuid",
    "selectedProperties": [["file"], ["processedAt"]]
  }
}

Uploads the new file and updates the Record reference.

Related pages