Preview a field type conversion
Runs the same conversion matrix the field update uses and returns the resulting plan: whether the pair of kinds is supported, how many values stay clean, are coerced, are narrowed or are dropped, the options it would mint, sample rows, and side effects such as view rules or formulas that would break. Nothing is written. Requires the `databases:write` permission.
Authorization
apiKey Workspace API key created in Workspace settings → API keys. Scopes on the key bound what it can read and write.
In: header
Path Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X POST "https://example.com/v1/workspaces/string/databases/string/fields/string/conversion/preview" \ -H "Content-Type: application/json" \ -d '{ "kind": "text" }'{ "data": { "fieldId": "string", "fromKind": "text", "toKind": "text", "supported": true, "lossy": true, "total": 0, "clean": 0, "coerced": 0, "narrowed": 0, "dropped": 0, "mintedOptions": [ { "key": "string", "name": "string", "color": "string", "recordCount": 0 } ], "warnings": [ { "kind": "view_rule", "label": "string", "detail": "string" } ], "samples": [ { "recordId": "string", "recordTitle": "string", "outcome": "clean", "before": "string", "after": "string" } ] }}{ "_tag": "ApiNotFound", "error": "not_found", "message": "That item does not exist, or this key cannot see it.", "status": 404}{ "_tag": "ApiNotFound", "error": "not_found", "message": "That item does not exist, or this key cannot see it.", "status": 404}Delete a field from a database
Removes the field, clears its values and drops the column from every view that showed it. Requires the `databases:write` permission. A field that is one end of a relation is refused - delete the relation instead - as is a field still referenced by a formula, rollup or other dependent.
Preview what deleting a field would affect
Returns the views, formulas, rollups, buttons and other references that depend on the field, with an overall status saying whether deletion is safe, needs confirmation, or is blocked. Read-only. Requires the `databases:write` permission.