Skip to navigation
Runtype APICollections

Update a collection

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
enforceCheckobjectOptional
schemaChangeobjectOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error