> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.runtype.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.runtype.com/_mcp/server.

# Update record

PUT https://api.runtype.com/v1/records/{id}
Content-Type: application/json

Update fields on an existing record.

Reference: https://docs.runtype.com/api-reference/runtype-api/records/update-record

## Authentication

- `Authorization` header (bearer token, required) — API key or Clerk session token

## Servers

- `https://api.runtype.com` (Production, default)
- `https://api.runtype-staging.com` (Staging)

## Request

### Path parameters

- `id` (string, required)

### Body (application/json)

This endpoint expects an object.

- `messages` (list of V1RecordsIdPutRequestBodyContentApplicationJsonSchemaMessagesItems, optional, nullable)
- `metadata` (map from string to any, optional) — Replaces the whole metadata object. Omit to leave metadata unchanged.
- `name` (string, optional)
- `ownerId` (string, optional, nullable) — Reassigns the owner (indexed owner_id column, filterable via ?ownerId=). Overrides a nested metadata.ownerId. Null clears the owner; omit to leave it unchanged.
- `type` (string, optional)

## Response

### 200

Updated record

- `createdAt` (string, required)
- `id` (string, required)
- `messages` (list of any, required, nullable)
- `metadata` (map from string to any, required)
- `name` (string, required)
- `organizationId` (string, required, nullable)
- `ownerId` (string, required, nullable)
- `productSurfaceId` (string, required, nullable)
- `schemaValid` (boolean, required, nullable)
- `type` (string, required)
- `updatedAt` (string, required)
- `userId` (string, required)
- `metadataLabels` (map from string to string, optional)
- `metadataSchema` (V1RecordsIdPutResponsesContentApplicationJsonSchemaMetadataSchema, optional)
- `schemaWarnings` (list of V1RecordsIdPutResponsesContentApplicationJsonSchemaSchemaWarningsItems, optional)
- `warnings` (list of V1RecordsIdPutResponsesContentApplicationJsonSchemaWarningsItems, optional)

## Errors

### 400 Bad Request Error

Validation error

- `error` (string, required)
- `code` (string, optional) — Stable error code. `insufficient_scope` marks an API key that lacks a scope this request needs.
- `details` (list of ErrorDetailsItems, optional)
- `requiredScopes` (list of string, optional) — On `insufficient_scope`: every API key scope this request needs.

### 401 Unauthorized Error

Unauthorized

- `error` (string, required)
- `code` (string, optional) — Stable error code. `insufficient_scope` marks an API key that lacks a scope this request needs.
- `details` (list of ErrorDetailsItems, optional)
- `requiredScopes` (list of string, optional) — On `insufficient_scope`: every API key scope this request needs.

### 403 Forbidden Error

Insufficient permissions

- `error` (string, required)
- `code` (string, optional) — Stable error code. `insufficient_scope` marks an API key that lacks a scope this request needs.
- `details` (list of ErrorDetailsItems, optional)
- `requiredScopes` (list of string, optional) — On `insufficient_scope`: every API key scope this request needs.

### 404 Not Found Error

Record not found

- `error` (string, required)
- `code` (string, optional) — Stable error code. `insufficient_scope` marks an API key that lacks a scope this request needs.
- `details` (list of ErrorDetailsItems, optional)
- `requiredScopes` (list of string, optional) — On `insufficient_scope`: every API key scope this request needs.

### 409 Conflict Error

Duplicate record (`duplicate_record`), or the record changed while this update was applied (`record_conflict`; re-read and retry)

- `error` (string, required)
- `code` (string, optional) — Stable error code. `insufficient_scope` marks an API key that lacks a scope this request needs.
- `details` (list of ErrorDetailsItems, optional)
- `requiredScopes` (list of string, optional) — On `insufficient_scope`: every API key scope this request needs.

### 422 Unprocessable Entity Error

Metadata violates the type's collection schema (enforce mode)

- `collection` (string, required)
- `details` (list of RecordSchemaValidationErrorDetailsItems, required)
- `error` (enum, required)
  - Allowed values: `schema_validation_failed`
- `schemaVersion` (integer, required)
- `recordId` (string, optional)
- `recordName` (string, optional)

### 500 Internal Server Error

Internal server error

- `error` (string, required)
- `code` (string, optional) — Stable error code. `insufficient_scope` marks an API key that lacks a scope this request needs.
- `details` (list of ErrorDetailsItems, optional)
- `requiredScopes` (list of string, optional) — On `insufficient_scope`: every API key scope this request needs.

### 503 Service Unavailable Error

The type's collection schema could not be loaded, so the write was refused rather than left unvalidated; retry

- `code` (enum, required)
  - Allowed values: `COLLECTION_LOOKUP_FAILED`
- `collection` (string, required) — The record type whose collection schema could not be loaded.
- `error` (string, required) — Human-readable refusal; retry the request.
- `recordId` (string, optional)
- `recordName` (string, optional)

## Types

### V1RecordsIdPutRequestBodyContentApplicationJsonSchemaMessagesItems

- `content` (V1RecordsIdPutRequestBodyContentApplicationJsonSchemaMessagesItemsContent, required)
- `role` (enum, required)
  - Allowed values: `user`, `assistant`

### V1RecordsIdPutResponsesContentApplicationJsonSchemaMetadataSchema

- `keys` (list of string, required)

### V1RecordsIdPutResponsesContentApplicationJsonSchemaSchemaWarningsItems

- `code` (string, required)
- `field` (string, required)
- `message` (string, required)

### V1RecordsIdPutResponsesContentApplicationJsonSchemaWarningsItems

- `code` (enum, required)
  - Allowed values: `KEY_RENAMED`
- `from` (string, required)
- `to` (string, required)

### ErrorDetailsItems

- `message` (string, required)
- `code` (string, optional) — Stable Runtype validation code (e.g. MISSING_REQUIRED_FIELD, INVALID_ENUM).
- `path` (string, optional) — Dotted JSON path to the offending field.
- `suggestion` (string, optional) — Actionable hint (allowed values, accepted range, …).

### RecordSchemaValidationErrorDetailsItems

- `code` (string, required)
- `field` (string, required)
- `message` (string, required)
- `path` (string, required)

### V1RecordsIdPutRequestBodyContentApplicationJsonSchemaMessagesItemsContent

- string
- list of any

## Examples

**Request**

```json
{}
```

**Response**

```json
{
  "createdAt": "string",
  "id": "string",
  "messages": [
    null
  ],
  "metadata": {},
  "name": "string",
  "organizationId": "string",
  "ownerId": "string",
  "productSurfaceId": "string",
  "schemaValid": true,
  "type": "string",
  "updatedAt": "string",
  "userId": "string",
  "metadataLabels": {},
  "metadataSchema": {
    "keys": [
      "string"
    ]
  },
  "schemaWarnings": [
    {
      "code": "string",
      "field": "string",
      "message": "string"
    }
  ],
  "warnings": [
    {
      "code": "KEY_RENAMED",
      "from": "string",
      "to": "string"
    }
  ]
}
```

**SDK Code**

```python
import requests

url = "https://api.runtype.com/v1/records/id"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.runtype.com/v1/records/id';
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.runtype.com/v1/records/id"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.runtype.com/v1/records/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.put("https://api.runtype.com/v1/records/id")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.runtype.com/v1/records/id', [
  'body' => '{}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.runtype.com/v1/records/id");
var request = new RestRequest(Method.PUT);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.runtype.com/v1/records/id")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PUT"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```