Update record | Runtype Documentation

{
  "createdAt": "2024-06-01T12:00:00Z",
  "id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
  "messages": [
    null
  ],
  "metadata": {},
  "name": "Project Alpha Record",
  "organizationId": "org_987654321",
  "productSurfaceId": "prod_surface_12345",
  "schemaValid": true,
  "type": "task",
  "updatedAt": "2024-06-10T15:30:00Z",
  "userId": "user_123456789",
  "metadataLabels": {},
  "metadataSchema": {
    "keys": [
      "priority",
      "category"
    ]
  },
  "schemaWarnings": [
    {
      "code": "DEPRECATED_FIELD",
      "field": "oldFieldName",
      "message": "The field 'oldFieldName' is deprecated and will be removed in future versions."
    }
  ],
  "warnings": [
    {
      "code": "KEY_RENAMED",
      "from": "oldKeyName",
      "to": "newKeyName"
    }
  ]
}

Update fields on an existing record.

Authentication

AuthorizationBearer

API key or Clerk session token

Path parameters

idstringRequired

Request

This endpoint expects an object.

messageslist of objects or nullOptional

metadatamap from strings to anyOptionalDefaults to {}

namestringOptional1-500 characters

typestringOptional1-255 characters

Response

Updated record

createdAtstring

idstring

messageslist of any or null

metadatamap from strings to any

namestring

organizationIdstring or null

productSurfaceIdstring or null

schemaValidboolean or null

typestring

updatedAtstring

userIdstring

metadataLabelsmap from strings to strings

metadataSchemaobject

schemaWarningslist of objects

warningslist of objects

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

422

Unprocessable Entity Error

500

Internal Server Error

$	curl -X PUT https://api.runtype.com/v1/records/id \
>	-H "Authorization: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{}'