Bind knowledge-base workgroup binding

POST /v1/sites/:id/group-binding

Binding changes site type to GROUP; unbinding changes it to KNOWLEDGE, not its original type. KNOWLEDGE/GROUP sites are supported. Bitrix24 checks group rights; the group may already have a knowledge base. After binding, read pages with scope=GROUP.

Requires landing key scope. Every route accepts optional query scope=KNOWLEDGE|GROUP|MAINPAGE. Bitrix24 selects its binding context; pre-read searches KNOWLEDGE, then GROUP and the supplied or default context.

Parameters

Parameter	Type	Required	Description
id	integer	yes	Positive safe site ID from GET /v1/sites
groupId	integer	yes	Positive safe workgroup ID from GET /v1/workgroups
scope	string	no	KNOWLEDGE / GROUP / MAINPAGE

The body contains only groupId.

curl

Terminal

curl -X POST "https://vibecode.bitrix24.com/v1/sites/42/group-binding" -H "X-Api-Key: YOUR_API_KEY" -H 'Content-Type: application/json' -d '{"groupId": 7}'

JavaScript

javascript

const response = await fetch("https://vibecode.bitrix24.com/v1/sites/42/group-binding", {
  method: "POST",
  headers: { "X-Api-Key": "YOUR_API_KEY", "Content-Type": "application/json" },
  body: JSON.stringify({"groupId": 7}),
});
const result = await response.json();

Response

JSON

{
  "success": true,
  "data": {
    "id": 42,
    "title": "VIBE-PROBE",
    "type": "GROUP",
    "active": false,
    "deleted": false,
    "bindings": [
      {
        "siteId": 42,
        "groupId": 7,
        "title": "VIBE-PROBE",
        "publicUrl": "https://example.bitrix24site.com/knowledge/"
      }
    ]
  }
}

READONLY rejects writes before Bitrix24. false returns 422 with possible reasons; true reads bindings back and, for groups, the site with its new type. Rebinding or removing a missing binding can also return false.

Errors

400 INVALID_PARAMS / INVALID_SCOPE / MISSING_REQUIRED_FIELDS; 401 TOKEN_MISSING; 403 SCOPE_DENIED / BITRIX_ACCESS_DENIED / WRITE_BLOCKED_READONLY_KEY; 404 ENTITY_NOT_FOUND; 409 SITE_BINDING_TYPE_MISMATCH / LANDING_MODULE_NOT_ENABLED; 422 BITRIX_ERROR; 429; 502 / 503.

Bitrix24: landing.site.bindingToGroup.

Sites