Delete entity schema

Changed on

<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.

Delete the entity's records first. An entity that still has records can't be removed, and the call changes nothing.

This changes the app's live data model, so it takes effect immediately. It doesn't change the file that defines that model in the app's source code. Since Base44 rebuilds the live model whenever the file is written or the app's code is pulled from GitHub, a change made using this endpoint may be reverted.

To change the model for good, change the entities configuration files.

Pass User as the entity_name to drop the custom fields from the built-in user entity. Unlike every other entity, this isn't blocked by existing records and it doesn't delete any app users. Their custom values stay in storage but stop being part of the user schema.

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

Request

  • Base URL: https://app.base44.com
  • URL: https://app.base44.com/api/apps/{app_id}/entity-schemas/{entity_name}
  • Auth: one of:
    • HTTP bearer
    • API key in header api_key
    • HTTP bearer

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.

app_idstring required

ID of the app whose entity schemas you want to work with.

Response

Successful Response

successboolean required

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

Example response

{
  "success": true
}

Changes

  • bbcd7d7e2e72Revision changes
    • info

      the endpoint scheme security WorkspaceApiKeyBearerAuth was added to the API

  • 5e139db2e643Revision changes
    • info

      the endpoint scheme security PersonalAccessTokenAuth was added to the API

    • info

      the endpoint scheme security WorkspaceApiKeyAuth was added to the API