Delete entity schema
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.
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.
apps:deploy scope.Authorizations
Personal API key.
Path Parameters
Name of the entity to remove, as returned by List entity schemas. Pass User to drop the built-in user entity's custom fields.
ID of the app whose entity schemas you want.
Response
The entity schema was removed.
Always true. A delete that failed returns an error status instead.
true