Skip to main content

Insert Record

Creates a new record in the specified table. The record ID (fid) is automatically generated and cannot be set manually.

Endpoint

POST /integration/tables/:table/records

Authentication

Requires a valid API token in the Authorization header.

Path Parameters

ParameterTypeRequiredDescription
tablestringYesThe internal table name (from Get Tables)

Request Body

FieldTypeRequiredDescription
fieldsobjectYesKey-value pairs where keys are field names and values are the data to insert. Must contain at least one field.

Field names must match the pattern ^[A-Za-z0-9_]+$ (letters, numbers, and underscores only).

warning

You cannot set primary key columns (such as fid). The API will reject the request if you attempt to include them.

Response

FieldTypeDescription
successbooleantrue on success
tablestringThe table the record was inserted into
insertedIdnumber | nullThe auto-generated ID of the new record
fieldsobjectThe field values that were inserted

Examples

Insert a customer record

Request

curl -X POST "https://api.ozari.co.il/integration/tables/tcust/records" \
-H "Authorization: Bearer your-api-token-here" \
-H "Content-Type: application/json" \
-d '{
"fields": {
"fname": "דוד כהן",
"fphone": "050-1234567",
"femail": "david@example.co.il",
"faddress": "רחוב הרצל 42",
"fcity": "תל אביב",
"fcontact": "דוד",
"fnotes": "לקוח VIP"
}
}'

Response

{
"success": true,
"table": "tcust",
"insertedId": 1547,
"fields": {
"fname": "דוד כהן",
"fphone": "050-1234567",
"femail": "david@example.co.il",
"faddress": "רחוב הרצל 42",
"fcity": "תל אביב",
"fcontact": "דוד",
"fnotes": "לקוח VIP"
}
}

Insert a work order

Request

curl -X POST "https://api.ozari.co.il/integration/tables/twork/records" \
-H "Authorization: Bearer your-api-token-here" \
-H "Content-Type: application/json" \
-d '{
"fields": {
"fname": "תיקון מזגן - משרד ראשי",
"fda": "2026-03-26",
"fstatus": "חדש"
}
}'

Response

{
"success": true,
"table": "twork",
"insertedId": 3892,
"fields": {
"fname": "תיקון מזגן - משרד ראשי",
"fda": "2026-03-26",
"fstatus": "חדש"
}
}

Error Responses

Missing fields

{
"success": false,
"error": "\"fields\" is required"
}

Status: 400 Bad Request

Invalid field name

{
"success": false,
"error": "Invalid field name: my-field"
}

Status: 400 Bad Request

Attempting to set primary key

{
"success": false,
"error": "Cannot set primary key column: fid"
}

Status: 400 Bad Request

Invalid table name

{
"success": false,
"error": "Invalid table name"
}

Status: 400 Bad Request

Notes

  • The fields object must contain at least one key-value pair.
  • All field names are validated against ^[A-Za-z0-9_]+$. Names with spaces, dashes, or special characters are rejected.
  • Use Get Fields to discover valid field names for a given table.
  • The insertedId corresponds to the auto-incremented primary key of the new row.