> 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.

# Bulk edit records

POST https://api.runtype.com/v1/records/bulk-edit
Content-Type: application/json

Bulk update or delete metadata fields on multiple records.

Reference: https://docs.runtype.com/api-reference/runtype-api/records/bulk-edit-records

## 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

### Body (application/json)

This endpoint expects an object.

- `applyToAll` (boolean, optional, default: false)
- `conditions` (list of V1RecordsBulkEditPostRequestBodyContentApplicationJsonSchemaConditionsItems, optional, default: [])
- `deleteFields` (list of string, optional, default: [])
- `dryRun` (boolean, optional, default: false)
- `recordFilter` (V1RecordsBulkEditPostRequestBodyContentApplicationJsonSchemaRecordFilter, optional)
- `recordIds` (list of string, optional)
- `updates` (map from string to any, optional, default: {})

## Response

### 200

Bulk edit result with before/after diffs

- `data` (list of V1RecordsBulkEditPostResponsesContentApplicationJsonSchemaDataItems, required)
- `recordIds` (list of string, required)
- `schemaWarnings` (list of V1RecordsBulkEditPostResponsesContentApplicationJsonSchemaSchemaWarningsItems, optional)
- `warnings` (list of V1RecordsBulkEditPostResponsesContentApplicationJsonSchemaWarningsItems, 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.

### 409 Conflict Error

A target record changed while the edit was applied (`record_conflict`); nothing was written, retry the edit

- `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

A record's post-merge metadata violates its type's collection schema (enforce mode); the whole edit is rejected

- `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

### V1RecordsBulkEditPostRequestBodyContentApplicationJsonSchemaConditionsItems

- `field` (string, required)
- `operator` (enum, required)
  - Allowed values: `equals`, `equals_ci`, `not_equals`, `contains`, `not_contains`
- `value` (V1RecordsBulkEditPostRequestBodyContentApplicationJsonSchemaConditionsItemsValue, required)

### V1RecordsBulkEditPostRequestBodyContentApplicationJsonSchemaRecordFilter

- `type` (string, required)
- `where` (V1RecordsBulkEditPostRequestBodyContentApplicationJsonSchemaRecordFilterWhere, optional)

### V1RecordsBulkEditPostResponsesContentApplicationJsonSchemaDataItems

- `after` (map from string to any, required)
- `before` (map from string to any, required)
- `id` (string, required)

### V1RecordsBulkEditPostResponsesContentApplicationJsonSchemaSchemaWarningsItems

- `errors` (list of V1RecordsBulkEditPostResponsesContentApplicationJsonSchemaSchemaWarningsItemsErrorsItems, required)
- `recordId` (string, required)

### V1RecordsBulkEditPostResponsesContentApplicationJsonSchemaWarningsItems

- `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)

### V1RecordsBulkEditPostRequestBodyContentApplicationJsonSchemaConditionsItemsValue

- string
- double
- boolean

### V1RecordsBulkEditPostRequestBodyContentApplicationJsonSchemaRecordFilterWhere

- RecordFilterCondition: RecordFilterCondition
- V1RecordsBulkEditPostRequestBodyContentApplicationJsonSchemaRecordFilterWhere1

### V1RecordsBulkEditPostResponsesContentApplicationJsonSchemaSchemaWarningsItemsErrorsItems

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

### RecordFilterCondition

- `field` (string, required)
- `op` (enum, required)
  - Allowed values: `eq`, `neq`, `gt`, `gte`, `lt`, `lte`, `between`, `contains`, `startsWith`, `endsWith`, `in`, `notIn`, `isSet`, `isNotSet`, `isTrue`, `isFalse`, `withinLastDays`, `olderThanDays`
- `value` (any, optional)

### V1RecordsBulkEditPostRequestBodyContentApplicationJsonSchemaRecordFilterWhere1

- `conditions` (list of V1RecordsBulkEditPostRequestBodyContentApplicationJsonSchemaRecordFilterWhereOneOf1ConditionsItems, required)
- `op` (enum, required)
  - Allowed values: `and`, `or`

### V1RecordsBulkEditPostRequestBodyContentApplicationJsonSchemaRecordFilterWhereOneOf1ConditionsItems

- RecordFilterCondition: RecordFilterCondition
- V1RecordsBulkEditPostRequestBodyContentApplicationJsonSchemaRecordFilterWhereOneOf1ConditionsItems1

### V1RecordsBulkEditPostRequestBodyContentApplicationJsonSchemaRecordFilterWhereOneOf1ConditionsItems1

- `conditions` (list of RecordFilterCondition, required)
- `op` (enum, required)
  - Allowed values: `and`, `or`

## Examples

**Request**

```json
{
  "conditions": [
    {
      "field": "category",
      "operator": "equals",
      "value": "test"
    }
  ],
  "deleteFields": [
    "obsolete_field"
  ],
  "dryRun": true,
  "updates": {
    "status": "archived"
  }
}
```

**Response**

```json
{
  "data": [
    {
      "after": {},
      "before": {},
      "id": "string"
    }
  ],
  "recordIds": [
    "string"
  ],
  "schemaWarnings": [
    {
      "errors": [
        {
          "code": "string",
          "field": "string",
          "message": "string"
        }
      ],
      "recordId": "string"
    }
  ],
  "warnings": [
    {
      "code": "KEY_RENAMED",
      "from": "string",
      "to": "string"
    }
  ]
}
```

**SDK Code**

```python Bulk Edit Records
import requests

url = "https://api.runtype.com/v1/records/bulk-edit"

payload = {
    "conditions": [
        {
            "field": "category",
            "operator": "equals",
            "value": "test"
        }
    ],
    "deleteFields": ["obsolete_field"],
    "dryRun": True,
    "updates": { "status": "archived" }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.json())
```

```javascript Bulk Edit Records
const url = 'https://api.runtype.com/v1/records/bulk-edit';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"conditions":[{"field":"category","operator":"equals","value":"test"}],"deleteFields":["obsolete_field"],"dryRun":true,"updates":{"status":"archived"}}'
};

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

```go Bulk Edit Records
package main

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

func main() {

	url := "https://api.runtype.com/v1/records/bulk-edit"

	payload := strings.NewReader("{\n  \"conditions\": [\n    {\n      \"field\": \"category\",\n      \"operator\": \"equals\",\n      \"value\": \"test\"\n    }\n  ],\n  \"deleteFields\": [\n    \"obsolete_field\"\n  ],\n  \"dryRun\": true,\n  \"updates\": {\n    \"status\": \"archived\"\n  }\n}")

	req, _ := http.NewRequest("POST", 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 Bulk Edit Records
require 'uri'
require 'net/http'

url = URI("https://api.runtype.com/v1/records/bulk-edit")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"conditions\": [\n    {\n      \"field\": \"category\",\n      \"operator\": \"equals\",\n      \"value\": \"test\"\n    }\n  ],\n  \"deleteFields\": [\n    \"obsolete_field\"\n  ],\n  \"dryRun\": true,\n  \"updates\": {\n    \"status\": \"archived\"\n  }\n}"

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

```java Bulk Edit Records
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.runtype.com/v1/records/bulk-edit")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"conditions\": [\n    {\n      \"field\": \"category\",\n      \"operator\": \"equals\",\n      \"value\": \"test\"\n    }\n  ],\n  \"deleteFields\": [\n    \"obsolete_field\"\n  ],\n  \"dryRun\": true,\n  \"updates\": {\n    \"status\": \"archived\"\n  }\n}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.runtype.com/v1/records/bulk-edit', [
  'body' => '{
  "conditions": [
    {
      "field": "category",
      "operator": "equals",
      "value": "test"
    }
  ],
  "deleteFields": [
    "obsolete_field"
  ],
  "dryRun": true,
  "updates": {
    "status": "archived"
  }
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

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

```csharp Bulk Edit Records
using RestSharp;

var client = new RestClient("https://api.runtype.com/v1/records/bulk-edit");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"conditions\": [\n    {\n      \"field\": \"category\",\n      \"operator\": \"equals\",\n      \"value\": \"test\"\n    }\n  ],\n  \"deleteFields\": [\n    \"obsolete_field\"\n  ],\n  \"dryRun\": true,\n  \"updates\": {\n    \"status\": \"archived\"\n  }\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Bulk Edit Records
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "conditions": [
    [
      "field": "category",
      "operator": "equals",
      "value": "test"
    ]
  ],
  "deleteFields": ["obsolete_field"],
  "dryRun": true,
  "updates": ["status": "archived"]
] as [String : Any]

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

let request = NSMutableURLRequest(url: NSURL(string: "https://api.runtype.com/v1/records/bulk-edit")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
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()
```