For AI agents: markdown of this page — /docs-content-en/infra/servers/b24-catalog-hide.md documentation index — /llms.txt
Remove the app from Bitrix24
POST /v1/infra/servers/:id/b24-catalog/hide
Hides the app from employees in the Bitrix24 catalog and deletes the app chat together with its history. Access to the app and its links stay the same.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
Parameterid (path) |
Typestring (UUID) | Requiredyes | DescriptionServer ID from the server list. The server must be managed by the API key used for the request |
The request body may be empty or {}. Unknown fields are ignored.
Examples
curl — personal key
curl -X POST -H "X-Api-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" -d '{}' \
https://vibecode.bitrix24.com/v1/infra/servers/SERVER_ID/b24-catalog/hide
curl — OAuth application
curl -X POST -H "X-Api-Key: YOUR_APP_KEY" \
-H "Authorization: Bearer USER_SESSION_TOKEN" \
-H "Content-Type: application/json" -d '{}' \
https://vibecode.bitrix24.com/v1/infra/servers/SERVER_ID/b24-catalog/hide
JavaScript — personal key
const res = await fetch(
`https://vibecode.bitrix24.com/v1/infra/servers/${serverId}/b24-catalog/hide`,
{
method: 'POST',
headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/json' },
body: '{}',
}
)
const body = await res.json()
if (!body.success) throw new Error(body.error.code)
console.log(body.data.showInBitrix24, body.data.queued)
JavaScript — OAuth application
const res = await fetch(
`https://vibecode.bitrix24.com/v1/infra/servers/${serverId}/b24-catalog/hide`,
{
method: 'POST',
headers: {
'X-Api-Key': 'YOUR_APP_KEY',
'Authorization': 'Bearer USER_SESSION_TOKEN',
'Content-Type': 'application/json',
},
body: '{}',
}
)
Response fields
| Field | Type | Description |
|---|---|---|
Fieldsuccess |
Typeboolean | Descriptiontrue when the choice is saved |
Fielddata.queued |
Typeboolean | Descriptiontrue if the card exists and its deletion has been queued. false if there is no card |
Fielddata.showInBitrix24 |
Typestring | DescriptionThe saved choice. Always NO |
Response example
Card deletion has been queued:
{
"success": true,
"data": {
"queued": true,
"showInBitrix24": "NO"
}
}
Error response example
404 — the server was not found or is managed by another API key:
{
"success": false,
"error": {
"code": "NOT_FOUND",
"message": "Server not found"
}
}
Errors
| HTTP | Code | Description |
|---|---|---|
| HTTP404 | CodeNOT_FOUND |
DescriptionThe server does not exist, has been deleted, or is managed by another API key |
| HTTP404 | CodeNOT_FOUND |
DescriptionThe server was deleted before the choice was saved |
| HTTP401 | CodeMISSING_API_KEY |
DescriptionThe X-Api-Key header is missing |
| HTTP401 | CodeINVALID_API_KEY |
DescriptionThe key is not recognized |
| HTTP403 | CodeINFRA_FORBIDDEN_FOR_COWORK_KEY |
DescriptionA Cowork key cannot perform write operations. Use a project key for deploy |
| HTTP429 | CodeRATE_LIMITED |
DescriptionRequest limit exceeded. Retry after the pause specified in the Retry-After header |
For the full list of shared API errors, see Errors.
Known specifics
- The card is deleted in the background. Check the server state for completion:
b24CatalogSync.itemIdbecomesnullandpendingOpis no longerDELETE. - You can hide the app before its card is created. The pending publication is canceled and the choice becomes
NO. Subsequent deployments keep this choice and do not create a card. - Publishing again creates a new chat. After deletion, show the app again if employees need it. The new chat will be empty; the previous history is not restored. While deletion is pending, publishing returns
409 CATALOG_DELETE_PENDINGand the choice staysNO. - Repeating the call keeps the choice. If the card no longer exists, the method returns
queued: falseandshowInBitrix24: "NO".