דילוג לתוכן הראשי

Create a record

POST 

/objects/:object_id/records

Create a record. Values go in values, keyed by field api_id, and are validated against the object: a missing required field, an unknown key, a choice outside the list or a link to a record that does not exist is a 400 naming the field (per-field detail under error.details.errors); a value another record already holds in a unique field is a 409. Read-only fields are ignored. Lookups on the new record are filled in before the response.

Value format per field type. Keys are each field's api_id (from GET /v1/objects/{object_id} → fields[]). Send JSON values as below; the "also accepted" column is there for integrations that only have text.

Field typeSendExampleAlso accepted / notes
textstring"Kitchen closet"One line, up to the field's max length (1,000 by default).
textareastring"Line one\nLine two"Up to 10,000 characters.
rich_textstring (HTML)"<p>Hi <b>Dana</b></p>"Allowed tags: p br b strong i em u s ul ol li a h1–h4 blockquote code pre; anything else is removed.
numbernumber12.5Numeric text such as "1,234.5". The field's min / max apply.
currencynumber1840The amount only — the currency is the field's own.
emailstring"dana@example.com"Stored lower-case.
phonestring"+972541234567"7–15 digits; spaces, dashes and brackets are ignored; a leading 00 becomes +.
urlstring"https://teloring.com"http / https only; "teloring.com" becomes https://teloring.com.
datestring YYYY-MM-DD"2026-10-07"DD/MM/YYYY. A date-time is converted to the date in the account's timezone.
datetimestring, ISO 8601"2026-10-07T14:30:00Z"Without Z / an offset the time is read in the account's timezone. Always returned in UTC.
checkboxbooleantrue1 / 0, "true" / "false", "yes" / "no".
dropdown, radiostring"Open"Must be one of the field's options (case-insensitive).
multi_selectarray of strings["VIP", "Wholesale"]A comma-separated string. Each value must be an option unless the field allows free values.
agent_pickerstring"12"An agent id from GET /v1/agents.
filearray of objects[{"id": "8f2kq1ab"}]Ids of files already in the Files Warehouse (GET /v1/files); up to 20.
relationarray of record ids["91ks2"]A single id string. cardinality: one takes at most one id, many up to 500. Ids must exist in the target object.
ratinginteger41 to the field's max; 0 or null clears it.
progressnumber45Between the field's start and end.
buttontruetrueClicks the button: the platform stores the time of the click (returned as an ISO date-time). A button cannot be cleared; Studio flows watching it run on every click.
lookup, related_count, auto_number, formula fields (formula: true)——Computed by the platform: read-only, refused on write.

To clear a field send null (or [] for multi_select, file and relation).

Request​

Responses​

Record created.

Response Headers
    X-Request-Id

    Correlation id for this request. Quote it when reporting a problem.