Update a record
▾
POST
/api/v1/records/updateChanges only the fields you send. Returns the record as it is after the update. Send an Idempotency-Key to make retries safe.
If the re-read fails, the result contains only the record id.
- Auth
X-API-Key- Counts as
- 1 request
- Idempotency
- supported
- Files
- up to 10 MB each
Headers
X-API-Keystringrequired- Read from your server environment.
Content-Typestringrequiredapplication/json.Idempotency-Keystringoptional- 1 to 128 visible ASCII characters. Repeat the same request with the same key and Beezr returns the first result instead of running it again (header
Idempotency-Replayed: true).
Body parameters
modulestringrequired- The module's table name, shown under the module name on its card in Beezr Designer (for example
cm_equipment_requests_base). idintegerrequired- Minimum 1.
dataobjectrequired- Field values keyed by each field's System name (Designer → module → Fields). Lookup, relation and user fields take the id of the chosen item. File fields take a FileUpload object (or an array for multi-file fields). Fields not in the module are ignored.
data.<file-field>.fileNamestringrequired- —
data.<file-field>.contentTypestringoptional- Informational
data.<file-field>.datastringrequired- Base64 file bytes
Returns
HTTP 200. Updated. data is the record after the update.
successbooleanoptional- —
dataobjectoptional- A record.
idis the record id; every other property is a field keyed by its System name. data.idintegeroptional- —
Field values come back in the same form the Designer shows them.
Errors
| HTTP | Code | What to do |
|---|---|---|
| 400 | MISSING_REQUIRED_FIELD | Send the required body fields. |
| 400 | INVALID_DATA | Check field System names. |
| 400 | INVALID_IDEMPOTENCY_KEY | Send one visible ASCII key, 1–128 characters. |
| 400 | KEY_FIELD_UNRESOLVED | Check the module key field. |
| 401 | AUTHENTICATION_FAILED | Check the API key. |
| 404 | MODULE_NOT_FOUND | Copy the module table name. |
| 409 | IDEMPOTENCY_KEY_REUSED | Keep the original body. |
| 409 | IDEMPOTENCY_IN_PROGRESS | Wait Retry-After: 2. |
| 409 | IDEMPOTENCY_RESULT_UNKNOWN | Reconcile before new work. |
| 400 | INVALID_CONTENT_PAYLOAD | Send a file object with fileName and data. |
| 400 | CONTENT_DECODE_FAILED | Send valid base64 in data. |
| 400 · 413 | CONTENT_TOO_LARGE | Keep files within 10 MB. |
| 429 | RATE_LIMIT_EXCEEDED | Wait for the rate-limit reset. |
| 429 | TOO_MANY_CONCURRENT_REQUESTS | Wait; keep at most 2 in flight. |
| 429 | MONTHLY_QUOTA_EXCEEDED | Stop retries until the 1st. |
| 409 · 422 · 500 | UPDATE_FAILED | 409 duplicate key · 422 rule or plan limit, fix the data · 500 retry once. |
| 500 | FIELD_LOAD_FAILED | Retry later. |
| 500 | INTERNAL_ERROR | Retry later. |