[{"data":1,"prerenderedAt":7},["ShallowReactive",2],{"docs-changelog\u002F2026-08-29":3,"docs-tabs-changelog\u002F2026-08-29":6},{"content":4,"lastmod":5},"# API changes: August 29, 2026\n\n[← Changelog](\u002Fdocs\u002Fchangelog) · [August 2026](\u002Fdocs\u002Fchangelog\u002F2026-08)\n\n### FIX-0829-1: importable field flag in guide\n\n**Before**\n\nIn `GET \u002Fv1\u002Fguide`, the detailed `data.entities[].fieldsDetailed` contract did not indicate whether a field could be set during import.\n\n**After**\n\nFor such fields, `data.entities[].fieldsDetailed` now includes `importable: true`. The response remains HTTP 200, and the compact `data.entities[].fields` map is unchanged.\n\n### NEW-0829-2: a link to a public app expands into a card\n\nA link to an app in `PUBLIC` mode reached a messenger or Bitrix24 chat as a bare subdomain address. The preview fetcher got the same page a browser did, and there was nothing for it to show.\n\nA link to an app in `PUBLIC` mode expands into a card with a title, a description and an image. The data comes from the app's catalogue entry; with no catalogue title the server name is used, with no icon the platform image. The gateway assembles the card itself: the app receives no request, and a sleeping server is not woken. Under any other access policy there is no card — the preview fetcher gets a neutral page with no title, description or image. A card that has already been shown cannot be recalled: the receiving side caches it, so switching the policy to a private one closes off new requests only. More — [Authorization in a Black Hole app](\u002Fdocs\u002Finfra\u002Fapp-runtime).\n\n### BC-0829-3: lead filters now support stage semantics\n\n> Old format supported until: not provided\n\n**Before**\n\n[GET \u002Fv1\u002Fleads](\u002Fdocs\u002Fentities\u002Fleads\u002Flist), [POST \u002Fv1\u002Fleads\u002Fsearch](\u002Fdocs\u002Fentities\u002Fleads\u002Fsearch), and [POST \u002Fv1\u002Fleads\u002Faggregate](\u002Fdocs\u002Fentities\u002Fleads\u002Faggregate) with a `stageSemanticId` filter returned `UNKNOWN_FILTER_FIELD`. A `stageSemanticId` field sent in create, update, import, entity batch, or global batch was ignored.\n\n**After**\n\nThe filter accepts `P` (in progress), `S` (success), and `F` (failure). Sorting by `stageSemanticId` is also available. The Guide, OpenAPI, and reference describe the field as a read-only string. `groupBy: stageSemanticId` remains unsupported. Create and update return `READONLY_FIELD`, import returns `IMPORT_ITEM_VALIDATION`, entity batch returns `BATCH_ITEM_VALIDATION`, and global batch returns `READONLY_FIELD` for the corresponding call.\n\n**What integrators should do**\n\nUse `stageSemanticId` only for reads, filters, and sorting. Remove the field from create, update, import, entity batch, and global batch bodies. Choose another field for grouping.\n\n### FIX-0829-4: mailbox and org-structure node list calls work in the batch APIs\n\n**Before**\n\nA `{\"entity\": \"mail-mailboxes\", \"action\": \"list\"}` sub-call in `POST \u002Fv1\u002Fbatch` answered\n`ERROR_METHOD_NOT_FOUND`, and the same list in `POST \u002Fv1\u002Fmail\u002Fmailboxes\u002Fbatch` answered\n`CALL_FAILED`. `humanresources-nodes` behaved the same way. As a standalone request,\n`GET \u002Fv1\u002Fmail-mailboxes` returned the same list with data.\n\n**After**\n\nBoth batch APIs return the records. Such a sub-call runs as a separate request to\nBitrix24 at any `limit` and spends its own rate-limit quota; neighbouring calls on other\nentities still travel in one batch. The record count on these two entities always\narrives, even with `withTotal: false`. The `get` action on them still does not answer\nwith data inside a batch — read the record through its own route. Details are in the\n\"Known specifics\" section of the \"Batch operations\" page.\n\nSeparately, the message text of a failed sub-call changed across all batch calls, not just\nfor these two entities. It used to carry the platform's internal diagnostic; now only text\nthat came from Bitrix24 is published, and everything else gets a fixed `Internal error`.\nQueue overflow, queue wait timeout and a Bitrix24 timeout no longer fall into that generic\ncode: they arrive under their own `QUEUE_OVERFLOW`, `QUEUE_TIMEOUT`, `BITRIX_TIMEOUT`,\n`ERROR_LOOP_DETECTED`, `RATE_LIMITED`, `OPERATION_TIME_LIMIT` and `TOKEN_REFRESH_FAILED`\ncodes, all but the last with a `retryAfter` field, so they can be told apart from an\ninternal failure. The response\nstays `200` and the codes of the other sub-errors are unchanged.\n\nThe same rule applies when the whole batch request fails rather than one call: the text\ncomes from the Bitrix24 response, and is fixed otherwise. The status, the code and the\n`bitrixError` field are unchanged — `bitrixError` arrives whenever Bitrix24 really\nanswered, even when its answer carried no text.\n\nSingle endpoints also stopped returning internal text in one case: a\n`TOKEN_REFRESH_FAILED` refusal now carries a fixed message — a fragment of the Bitrix24\nresponse could previously end up in it. The code and the status are unchanged.\n",null,{},1794739477035]