Skip to main content

Create a new record

POST 
/api/v1/orgs/:orgID/datasets/:datasetID/records

Create a new record in a specific dataset for an organization.

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:

  • The createdAt field is optional. If not provided, it will be set to the current time.
  • Progress tracker states are optional. If only the currentStateId is provided, the states will be automatically populated with the current time.

Example Data Field:

{
"field_text": "Sample text",
"field_number": 42.5,
"field_date": "2024-01-15",
"field_datetime": "2024-01-15T10:30:00Z",
"field_select": "option_123",
"field_multiselect": ["option_1", "option_2"],
"field_progress_simple": {"currentStateId": "in_progress"},
"field_progress_detailed": {"currentStateId": "in_progress", "states": {"state_1": {"startTime": "2024-01-15T10:30:00Z"}, "in_progress": {"startTime": "2024-01-15T10:30:00Z"}}},
"field_relationship": [{"relatedRecordId": "record_456"}],
"field_events": {"markers": [{"id": "event_1", "label": "Milestone reached"}]}
}

Request​

Responses​

Record created successfully