Delete a type
Deletes a type no item holds and no folder, view, webhook or table column names. With force=true, keeps the items, settings and column constraints; new item writes fail until the type is registered again.
bearerAuthAuthorizationBearer <token>Authenticate with an API key (marfa_k1_…) or an OAuth access token (marfa_at_…).
id*stringThe identifier of the type, such as acme.deal.
force?booleanDelete the type even if items of it exist, in any state, or a folder, view or webhook names it. It doesn't cover subtypes or compatibility dependents.
X-Marfa-Instance-Id?stringThe ID of the instance you expect, as GET / returns it. If another instance answers at this address, Marfa returns 409 instance_changed and doesn't write. Leave it out to send the request to whichever instance answers.
^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$Returns ok: true.
application/json- response
Confirms that the request succeeded.
ok*trueAlways true.
truevalidation_error: the query has a parameter this endpoint doesn't take.
application/json- response
An error response.
error*What went wrong.
unauthorized: the request has no credential, or its credential is not valid. For a key that has expired, details.expired_at says when it expired.
application/json- response
An error response.
error*What went wrong.
forbidden: you lackschema.write, or the local command requestedforce=true.core_type_immutable: Marfa ships this type, and no credential can delete it.type_not_permitted: your type map doesn't grant write on the type.
application/json- response
An error response.
error*What went wrong.
type_not_found: no type has this identifier.
application/json- response
An error response.
error*What went wrong.
type_has_subtypes: other types name this one as theirparent(details.subtype_idslists them). Delete them, or give them another parent withPUT /types/{id}.type_in_use: an item of the type exists, in any state, or a folder, view, webhook or column names it, andforceisn'ttrue.detailslists them. Move them withPOST /types/{id}/move.
application/json- response
An error response.
error*What went wrong.
contract_mismatch: X-Marfa-Contract names another contract version than this instance speaks, or is not a whole number. Nothing was done.
application/json- response
An error response.
error*What went wrong.
request_too_large: the request body is larger than this instance accepts.
application/json- response
An error response.
error*What went wrong.
compatible_with_violation: other types name this type in compatible_with. details.dependent_type_ids lists them. Remove their claims before deleting the target; force=true does not bypass this check.
application/json- response
An error response.
error*What went wrong.
rate_limited: you sent too many requests. Wait for the number of seconds in Retry-After, then try again.
application/json- response
An error response.
error*What went wrong.
internal_error: Marfa failed in a way it didn't expect, and the request may not have completed. Read what you changed before you repeat a write.
application/json- response
An error response.
error*What went wrong.
write_contention: the database was busy, and Marfa couldn't complete the request in time. Nothing changed. Try the request again. While a restore runs, details.reason is restore_running.
application/json- response
An error response.
error*What went wrong.
insufficient_storage: the disk that holds the instance's data has no room for the request, or the request would leave less free than the instance keeps in reserve. Nothing changed, unless details.write_outcome is unknown, which means the write may have landed: read what you changed before you repeat it. Free space on the disk, then try the request again.
application/json- response
An error response.
error*What went wrong.
curl -X DELETE 'http://localhost:8600/types/string'{ "ok": true}