Custom objects

Update a record

Only the fields you send change; an empty value inside fields clears that field. active: false archives, true restores. POST is accepted too.

PATCH/api/v1/objects/{key}/records/{id}

Authorization

Authorizationheaderrequired

Bearer token: API key (sk_…), OAuth access token (mcp_…) or mobile session (xk_…).

Module: CustomersScope: crm.write

Path parameters

keystringrequired

Object key.

idintegerrequired

Record id.

Body application/json

namestringoptional

Name.

owner_idintegeroptional

Owner user (empty = none).

activebooleanoptional

Archive state.

fieldsobjectoptional

Field key → value.

linksobjectoptional

Relations to add.

Errors

HTTP	error	Meaning
`400`	`invalid`	Missing or invalid field (`message` explains).
`403`	`forbidden`	You may not see / edit this record.
`404`	`not_found`	Record not found.

Request

curl -X PATCH https://ornek.solk.app/api/v1/objects/uretim_hatti/records/1 \
  -H "Authorization: Bearer $SOLK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "fields": {
    "hiz": 220
  }
}'

const res = await fetch("https://ornek.solk.app/api/v1/objects/uretim_hatti/records/1", {
  method: "PATCH",
  headers: {
    Authorization: `Bearer ${process.env.SOLK_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "fields": {
      "hiz": 220
    }
  }),
});
const data = await res.json();

import os, requests

r = requests.patch(
    "https://ornek.solk.app/api/v1/objects/uretim_hatti/records/1",
    headers={"Authorization": f"Bearer {os.environ['SOLK_API_KEY']}"},
    json={
        "fields": {
            "hiz": 220
        }
    },
)
print(r.json())

Response

{
  "ok": true,
  "record": {
    "active": true,
    "customer": {
      "id": 1,
      "name": "Alize Paketleme San. ve Tic. A.Ş."
    },
    "editable": true,
    "field_list": [
      {
        "display": "Ekstrüzyon",
        "key": "makine_tipi",
        "label": "Makine tipi",
        "options": [
          "Laminasyon"
        ],
        "required": true,
        "type": "select",
        "value": "Ekstrüzyon"
      }
    ],
    "fields": {
      "devreye_alma": "2025-04-01",
      "hiz": 220.0,
      "makine_tipi": "Ekstrüzyon"
    },
    "id": 1,
    "name": "Hat 3 — şişirme",
    "owner": "Deniz Aksoy",
    "owner_id": 1,
    "relations": [
      {
        "items": [
          {
            "id": 1,
            "name": "Alize Paketleme San. ve Tic. A.Ş."
          }
        ],
        "key": "co1_customer",
        "kind": "customer",
        "label": "Firma",
        "many": false,
        "side": "a",
        "target_label": "Firma"
      }
    ],
    "sub": "Ekstrüzyon · 220",
    "updated_at": "2026-10-06T10:26:24",
    "url": "https://ornek.solk.app/o/uretim_hatti/1"
  }
}

Example responses were captured from a v43b installation running sample data; lists are shortened to two items.