Sign in

Delete entity schema

<Info>This API is in beta. Endpoints, fields, and behavior may still change, so avoid depending on it in production.</Info>

Removes an entity from the app.

The entity has to be empty first. A delete on an entity that still has records returns a 428 and changes nothing, so delete its records before calling this.

<Warning>This changes the app's live schema right away, but it does not change the entity definition in the app's source code. Base44 rebuilds the live schema from the source files whenever the app's code changes, which reverts anything you set here. Change the code itself when you need the edit to last.</Warning>

Pass User as the entity_name to drop the custom fields from the built-in user entity. That does not delete any app users, and it is not blocked by existing records: the custom values stay in storage but stop being part of the user schema.

A name the app does not have returns a 404, except for a workspace API key, which gets a 200 so a repeated deploy is safe.

<Note>This endpoint accepts a personal API key, or a workspace API key with the apps:deploy scope.</Note>

delete/api/apps/{app_id}/entity-schemas/{entity_name}

Path parameters

entity_namestring required

Name of the entity to remove, as returned by List entity schemas. Pass User to drop the built-in user entity's custom fields.

Name of the entity to remove, as returned by List entity schemas. Pass User to drop the built-in user entity's custom fields.

app_idstring required

ID of the app whose entity schemas you want.

ID of the app whose entity schemas you want.

Response

The entity schema was removed.

successboolean required

Always true. A delete that failed returns an error status instead.

Example response

{
  "success": true
}

Changes