Update a record by id (hosted RecordStore.update)

curl -X POST https://api.runtype.com/v1/runtime/records/update \
     -H "Authorization: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "id": "rec_8f3b2a1d4c5e7f90",
  "metadata": {}
}'

{
  "record": {
    "createdAt": "2024-05-20T10:15:30Z",
    "id": "rec_8f3b2a1d4c5e7f90",
    "metadata": {},
    "name": "User Profile Record",
    "organizationId": "org_1234567890abcdef",
    "type": "user_profile",
    "updatedAt": "2024-05-21T08:45:00Z",
    "userId": "user_abcdef1234567890",
    "messages": [
      {
        "content": "Record updated successfully.",
        "role": "system"
      }
    ],
    "metadataLabels": {},
    "metadataSchema": {},
    "productSurfaceId": "prod_0987654321fedcba",
    "schemaValid": true
  }
}

Hosted fulfillment of the runtime RecordStore seam. Updates an existing record by id with the merge (shallow) / replace / deep-merge strategy, scoped to the authenticated caller. Returns { record: null } when no row matched. Requires an Enterprise plan: ineligible accounts receive 403 (code BYOC_PLAN_REQUIRED).

Authentication

AuthorizationBearer

API key or Clerk session token

Request

This endpoint expects an object.

idstringRequired>=1 character

metadatamap from strings to anyRequired

mergeStrategyenumOptional

Allowed values:

Response

The updated record or null

recordobject or null

Errors

400

Bad Request Error

401

Unauthorized Error

402

Payment Required Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error