Skip to main content

Update an existing record

PATCH 
/api/v1/orgs/:orgID/datasets/:datasetID/records/:recordID

Update an existing record in a specific dataset for an organization.

Partial Updates: This endpoint supports partial updates. Only include the fields you want to update in the request body. Fields not included in the request will retain their current values.

Data Field Structure: The data field is a map where keys are field IDs and values depend on field type:

Supported Field Types:

  • text - Single or multi-line text input
  • number - Numeric values (integers, decimals)
  • date - Date only (YYYY-MM-DD format)
  • datetime - Date and time (ISO 8601 format)
  • select - Single choice dropdown
  • multiselect - Multiple choice selection
  • progress-tracker - Workflow states with progression tracking
  • relationship - Links to other records in the system
  • event-markers - Track phases of a live event

Notes:

  • Progress tracker states are optional. You can provide just currentStateId and the system will auto-populate timestamps, or provide explicit states with custom timestamps.

Example Data Field Updates:

{
"field_text": "Updated text",
"field_number": 99.5,
"field_date": "2024-02-20",
"field_datetime": "2024-02-20T15:45:00Z",
"field_select": "option_456",
"field_multiselect": ["option_3", "option_4"],
"field_progress_simple": {"currentStateId": "completed"},
"field_progress_detailed": {"currentStateId": "completed", "states": {"completed": {"startTime": "2024-02-20T15:45:00Z"}}},
"field_relationship": [{"relatedRecordId": "record_789"}],
"field_events": {"markers": [{"id": "event_2", "label": "Phase completed"}]}
}

Request​

Responses​

Record updated successfully