Sync entity schemas

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

Replaces the specified app’s entire set of entities with the one you send, in a single call.

Send every entity the app should have. Any entity the app currently has that is missing from entityNameToSchema is deleted. Include User to keep its custom fields. Leaving it out drops them. An empty object deletes every entity the app has.

Base44 won’t delete an entity that still holds records. If the set you send leaves out an entity that has records, the whole call fails and nothing changes.

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.

This endpoint requires the app’s source code to be under your control. That includes projects you create with the Base44 CLI and projects you eject from the Base44 online app editor. Some managed-source apps may also be granted access.

PUT /api/apps/{app_id}/entity-schemas

Sync entity schemas

cURL

curl --request PUT \
  --url https://app.base44.com/api/apps/{app_id}/entity-schemas \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "entityNameToSchema": {
    "Invoice": {
      "name": "Invoice",
      "properties": {
        "amount": {
          "description": "Total amount in cents",
          "type": "number"
        },
        "status": {
          "enum": [
            "draft",
            "sent",
            "paid"
          ],
          "type": "string"
        }
      },
      "required": [
        "amount"
      ],
      "rls": {
        "read": {
          "created_by": "{{user.email}}"
        }
      },
      "type": "object"
    }
  }
}
'

200

{
  "created": [
    "Invoice"
  ],
  "updated": [
    "Customer"
  ],
  "deleted": [
    "LegacyOrder"
  ],
  "warnings": [
    "Invalid RLS rule in Invoice: \"properties.total.rls.delete\" — field-level delete rules are not enforced — delete removes the whole record (there is no field-level delete gate); put the restriction in a top-level rls.delete instead."
  ]
}

Authorizations

api_key · string · header · required

Personal API key.

Path Parameters

app_id · string · required

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

Body

application/json

entityNameToSchema · Entitynametoschema · object · required

The app's complete set of entities, keyed by entity name. Each value is that entity's JSON Schema, which needs "type": "object" and a properties object, plus any required fields and row-level security rules under rls. Any entity the app currently has that this map leaves out is deleted.

Show child attributes

Example:

{
  "Invoice": {
    "name": "Invoice",
    "properties": {
      "amount": {
        "description": "Total amount in cents",
        "type": "number"
      },
      "status": {
        "enum": ["draft", "sent", "paid"],
        "type": "string"
      }
    },
    "required": ["amount"],
    "rls": {
      "read": { "created_by": "{{user.email}}" }
    },
    "type": "object"
  }
}

Response

200

application/json

Successful Response

What a schema sync changed, split into created, updated, and deleted entities.

created · string[] · required

Entities that did not exist before and were added.

Example:

["Invoice"]

updated · string[] · required

Entities that already existed and were replaced.

Example:

["Customer"]

deleted · string[] · required

Entities the app had and the request left out, which were removed.

Example:

["LegacyOrder"]

warnings · string[] · required

Row-level security rules Base44 stored but can't enforce. The sync still applied, so an entity named here exists with a rule that isn't protecting anything. Base44 reports a rule this way only for an entity the sync adds fresh (one that didn't exist in the app before). On an entity the app already has, a new or changed rule of this kind fails the call with a 400. An unchanged unenforceable rule on an existing entity is left in place silently and doesn't appear here.

Example:

[
  "Invalid RLS rule in Invoice: \"properties.total.rls.delete\" — field-level delete rules are not enforced — delete removes the whole record (there is no field-level delete gate); put the restriction in a top-level rls.delete instead."
]