Update a collection

PATCH

/v1/collections/:slug

PATCH

/v1/collections/:slug

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

1 {
2   "collection": {
3     "createdAt": "2024-05-20T10:15:30Z",
4     "description": "Collection of user profiles with validation rules for data integrity.",
5     "displayName": "User Profiles",
6     "icon": "user-circle",
7     "id": "col_1234567890abcdef",
8     "indexedFields": [
9       "email",
10       "username"
11     ],
12     "schema": {},
13     "schemaVersion": 3,
14     "slug": "user-profiles",
15     "updatedAt": "2024-06-01T08:45:00Z",
16     "validationMode": "off",
17     "recordCount": 1523
18   },
19   "enforceCheck": {
20     "checked": 1000,
21     "failed": 25,
22     "truncated": false
23   },
24   "schemaChange": {
25     "breakingChanges": [],
26     "kind": "additive"
27   }
28 }

Update display fields, validation mode, or the schema. Schema changes are classified additive vs breaking; breaking changes are rejected while the resulting mode is enforce (drop to warn, migrate, re-enforce). Every schema change bumps schemaVersion and appends a history row. When the mode transitions to enforce, the response includes enforceCheck — a bounded dry-run of existing records against the schema.

Update display fields, validation mode, or the schema. Schema changes are classified additive vs breaking; breaking changes are rejected while the resulting mode is `enforce` (drop to `warn`, migrate, re-enforce). Every schema change bumps `schemaVersion` and appends a history row. When the mode transitions to `enforce`, the response includes `enforceCheck` — a bounded dry-run of existing records against the schema.

Authentication

AuthorizationBearer

API key or Clerk session token

Path parameters

slugstringRequired

Request

This endpoint expects an object.

descriptionstring or nullOptional<=4000 characters

displayNamestringOptional1-255 characters

iconstring or nullOptional<=64 characters

schemamap from strings to any or nullOptional

Constrained JSON Schema dialect: root object with string/number/boolean/array/object properties, one nesting level, no $ref/oneOf/pattern

slugstringOptional1-255 characters

validationModeenumOptional

Allowed values:

Response

Updated collection

collectionobject

enforceCheckobject

schemaChangeobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error