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 type | Send | Example | Also accepted / notes |
|---|---|---|---|
text | string | "Kitchen closet" | One line, up to the field's max length (1,000 by default). |
textarea | string | "Line one\nLine two" | Up to 10,000 characters. |
rich_text | string (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. |
number | number | 12.5 | Numeric text such as "1,234.5". The field's min / max apply. |
currency | number | 1840 | The amount only — the currency is the field's own. |
email | string | "dana@example.com" | Stored lower-case. |
phone | string | "+972541234567" | 7–15 digits; spaces, dashes and brackets are ignored; a leading 00 becomes +. |
url | string | "https://teloring.com" | http / https only; "teloring.com" becomes https://teloring.com. |
date | string YYYY-MM-DD | "2026-10-07" | DD/MM/YYYY. A date-time is converted to the date in the account's timezone. |
datetime | string, ISO 8601 | "2026-10-07T14:30:00Z" | Without Z / an offset the time is read in the account's timezone. Always returned in UTC. |
checkbox | boolean | true | 1 / 0, "true" / "false", "yes" / "no". |
dropdown, radio | string | "Open" | Must be one of the field's options (case-insensitive). |
multi_select | array of strings | ["VIP", "Wholesale"] | A comma-separated string. Each value must be an option unless the field allows free values. |
agent_picker | string | "12" | An agent id from GET /v1/agents. |
file | array of objects | [{"id": "8f2kq1ab"}] | Ids of files already in the Files Warehouse (GET /v1/files); up to 20. |
relation | array 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. |
rating | integer | 4 | 1 to the field's max; 0 or null clears it. |
progress | number | 45 | Between the field's start and end. |
button | true | true | Clicks 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
- 201
- 400
- 401
- 402
- 403
- 404
- 409
Record created.
Response Headers
Correlation id for this request. Quote it when reporting a problem.
The request was malformed, or a parameter was rejected.
Response Headers
Correlation id for this request. Quote it when reporting a problem.
No token, an expired token, or a credential that has been revoked.
Response Headers
Correlation id for this request. Quote it when reporting a problem.
A plan ceiling or a locked feature stopped an otherwise valid request.
Response Headers
Correlation id for this request. Quote it when reporting a problem.
Refused. Either the credential does not hold the scope this endpoint needs (code: insufficient_scope), or the account's IP allow-list does not include the calling address (code: ip_not_allowed).
Response Headers
Correlation id for this request. Quote it when reporting a problem.
No such resource in this account.
Response Headers
Correlation id for this request. Quote it when reporting a problem.
The request was valid but conflicts with the current state.
Response Headers
Correlation id for this request. Quote it when reporting a problem.