Sign in

v1

latestOpenAPI 3.1.0raw.githubusercontent.com2026-06-25173140700.7 KB
Application

Update an application

Update an existing application (superadmin only).

patch/applications/{app_id}

Path parameters

app_idinteger required

ID of the application to update.

ID of the application to update.

Query parameters

cookie_namestring nullable

Request body

namestring required

Display name of the application.

is_activeboolean

Whether the application is active and available to users.

tenant_idinteger required

ID of the tenant the application belongs to.

app_urlstring nullable

URL where an external (non-native) application is hosted.

is_nativeboolean nullable

Whether the application is a native, built-in application.

native_app_idinteger nullable

Identifier of the native application, when is_native is true.

descriptionstring nullable

Optional description of what the application does.

versionstring nullable

Version string of the application.

avatarstring nullable

URL or identifier of the application's avatar image.

Example request

{
  "name": "Knowledge Assistant",
  "is_active": true,
  "tenant_id": 1,
  "app_url": "https://apps.example.com/assistant",
  "native_app_id": 10,
  "description": "Answers questions over the company knowledge base.",
  "version": "1.0.0",
  "avatar": "https://cdn.example.com/avatars/assistant.png"
}

Response

Successful Response

created_atstring date-time

UTC timestamp when the record was created.

updated_atstring date-time

UTC timestamp when the record was last updated.

idinteger nullable

Primary key for applications.

namestring

Name of the application.

tenant_idinteger required

ID of the tenant that owns the application.

is_activeboolean

Whether the application is active.

is_nativeboolean

Whether the application is a native (built-in) application.

app_urlstring

Unique URL identifier for the application.

native_app_idinteger nullable

Unique identifier for native applications only.

descriptionstring nullable

Description of the application.

versionstring nullable

Version of the application.

avatarstring nullable

Avatar image (URL or encoded data) for the application.

creator_user_idinteger nullable required

ID of the user who created the app.

Example response

{
  "created_at": "2026-01-15T10:30:00Z",
  "updated_at": "2026-01-16T08:00:00Z",
  "is_active": true,
  "avatar": "https://cdn.example.com/app-icon.png"
}