Bulk edit records | Runtype Documentation

curl -X POST https://api.runtype.com/v1/records/bulk-edit \
     -H "Authorization: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "conditions": [
    {
      "field": "category",
      "operator": "equals",
      "value": "test"
    }
  ],
  "deleteFields": [
    "obsolete_field"
  ],
  "dryRun": true,
  "updates": {
    "status": "archived"
  }
}'

{
  "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"
    }
  ]
}

Bulk update or delete metadata fields on multiple records.

Authentication

AuthorizationBearer

API key or Clerk session token

Request

This endpoint expects an object.

applyToAllbooleanOptionalDefaults to false

conditionslist of objectsOptionalDefaults to []

deleteFieldslist of stringsOptionalDefaults to []

dryRunbooleanOptionalDefaults to false

recordFilterobjectOptional

recordIdslist of stringsOptional

updatesmap from strings to anyOptionalDefaults to {}

Response

Bulk edit result with before/after diffs

datalist of objects

recordIdslist of strings

schemaWarningslist of objects

warningslist of objects

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

422

Unprocessable Entity Error

500

Internal Server Error