update-data-record

update-data-record Function Type

The update-data-record function type updates an existing data record by ID.

Usage

This function type is used in Actions to provide access to data collection update functionality.

Configuration Example

name: Update Task
key: update-task
inputSchema:
  type: object
  properties:
    title:
      type: string
    status:
      type: string
type: update-data-record
config:
  dataSource:
    collectionKey: tasks
  fieldMapping:
    exportValue:
      summary:
        $var: $.input.title
      status:
        $var: $.input.status
  # Required: record ID
  id:
    $var: $.input.taskId

Configuration Parameters

  • dataSource - Data source configuration
    • collectionKey - Identifier of the data collection to operate on
    • collectionParameters - Parameters passed to the collection methods
    • udm - (for universal integrations only) Universal Data Model to write
  • fieldMapping - Field mapping configuration
    • exportValue - Maps fields from your app to the external app format
  • id - Record ID to update (supports formulas)

Output Schema

type: object
properties:
  id:
    type: string