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.
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
Response Body
application/json
application/json
application/json
curl -X DELETE "https://example.com/v1/workspaces/string/databases/string/fields/string"{ "data": { "id": "string", "workspaceId": "string", "databaseId": "string", "key": "string", "label": "string", "kind": "text", "required": true, "defaultValue": "string", "options": [ { "id": "string", "key": "string", "name": "string", "color": "string", "order": 0 } ], "settings": {}, "order": 0, "createdAt": "string", "updatedAt": "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}Update a field on a database
Changes a field's label, requiredness, default, options, order or settings, and runs a planned type conversion when `kind` changes - a conversion whose plan drops values is refused unless the caller sets `acceptDropped`. Requires the `databases:write` permission and responds with not-found for an unknown field. Send an `Idempotency-Key` header to make retries safe; a replay within the window returns the original response.
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.