v12

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-0118044135.0 KB

rest

Installs a local personal application

Request example: { "title": "Test application", "handlerUrl": "https://example.com", "scopes": ["crm"], "mobile": false, "menuTitles": { "en": "Test application" } } If menuTitles is omitted, the application is installed as API-only: it is not shown in the Bitrix24 interface, and its only way to access the portal is through the REST API, but it can still add embeddings.

post/rest.application.personal.install

Request body

titlestring required

handlerUrlstring required

mobileboolean required

clientIdstring

applicationTokenstring

selectstring[]

Example request

{
  "title": "string",
  "handlerUrl": "string",
  "mobile": true,
  "clientId": "string",
  "applicationToken": "string",
  "select": [
    "id",
    "clientId",
    "clientSecret",
    "applicationToken",
    "scopes",
    "title",
    "url",
    "urlInstall",
    "urlSettings",
    "mobile",
    "version",
    "active",
    "installed",
    "dateCreate",
    "dateInstall",
    "attributes"
  ]
}

Response

Success response