Sign in

Update app

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

Changes the app's name, its description, or both.

Send only the fields you want to change. A field you leave out keeps its value.

Renaming doesn't change the app's address. Change that with Change app slug.

<Warning>This endpoint also accepts other app fields, but only name and user_description are part of this API. Don't send anything else. Other fields aren't covered by the contract and can change or be rejected without notice.</Warning>

put/api/apps/{app_id}

Path parameters

{"stackTrail":"paths:/api/apps/{app_id}:put:parameters:0:schema","oasType":"schema","type":"unknown","title":"App Id"}

ID of the app.

Request body

namestring

New name for the app.

user_descriptionstring nullable

New description for the app, or null to remove it.

Example request

{
  "name": "Nordwind Furniture",
  "user_description": "An online catalog and order tracker for a furniture workshop."
}

Response

The app, with its new details.

idstring nullable

ID of the app.

namestring nullable

Display name of the app.

slugstring nullable

URL slug for the app, auto generated from the name and app ID or set to a custom value, or null if the app has no slug yet. The published URL is built from it.

user_descriptionstring nullable

Description of the app, or null if none was set. An app created without a name gets a generated description once a build turn changes it.

created_bystring nullable

Email of the user who created the app.

created_datestring date-time nullable

Time the app was created, as a UTC timestamp in ISO 8601 format.

updated_datestring date-time nullable

Time the app document was last written, as a UTC timestamp in ISO 8601 format.

last_deployed_atstring date-time nullable

Time the app was last published, as a UTC timestamp in ISO 8601 format, or null if it has never been published.

screenshot_urlstring nullable

URL of a screenshot of the published app. Captured shortly after each publish, so it can briefly lag or be null right after publishing.

preview_screenshot_urlstring nullable

URL of a preview screenshot taken before publishing, distinct from screenshot_url, or null if none has been captured.

main_branch_protectedboolean nullable

Whether the app's main branch is protected, so changes to main must go through a branch that's merged back. Change it with Set main branch protection.

Example response

{
  "id": "6820f3a4e7b91d003c45a1f2",
  "name": "My CRM",
  "slug": "my-crm-3c45a1f2",
  "user_description": "A CRM to track leads and deals",
  "created_by": "developer@example.com",
  "created_date": "2026-08-01T09:15:00",
  "updated_date": "2026-08-02T14:30:00",
  "status": {
    "state": "ready",
    "details": "Publishing app",
    "request_id": "a1b2c3d4e5f67890abcdef12",
    "last_updated_date": "2026-08-02T14:30:00Z",
    "error_source": "build",
    "paywall_context": {
      "billing_organization_id": "67e0b12c4d8a3f005b21c9e4",
      "user_id": "6706af53b9c1e2004a37d85f",
      "evaluated_at": "2026-08-02T14:30:00Z"
    }
  },
  "last_deployed_at": "2026-08-02T14:30:00",
  "screenshot_url": "https://storage.base44.com/screenshots/6820f3a4e7b91d003c45a1f2.png",
  "preview_screenshot_url": "https://storage.base44.com/previews/6820f3a4e7b91d003c45a1f2.png"
}

Changes

Changed in 2 of the 14 revisions of this API.2