Рабочие группы

Управление рабочими группами и проектами портала: создание, получение, обновление, удаление, поиск. Рабочая группа объединяет сотрудников вокруг общей темы или проекта — у неё есть владелец, тема, флаги открытости и архивирования, а также счётчик участников.

Битрикс24 API: sonet_group.* Скоуп: sonet_group

Создать рабочую группу

POST /v1/workgroups

Создаёт новую рабочую группу на портале. Возвращает полный объект созданной группы. Обязательное поле одно — name; остальные параметры опциональны.

Поля запроса (body)

Поле Тип Обяз. По умолч. Описание
name string ★ — Название рабочей группы
description string нет — Описание
ownerId number нет текущий пользователь ключа Идентификатор владельца группы. Список: GET /v1/users
subjectId number нет тема портала по умолчанию Идентификатор темы
active boolean нет true Активна ли группа
visible boolean нет true Видна ли в общих списках
opened boolean нет false Открыта ли для вступления без приглашения
archived boolean нет false Поместить в архив сразу при создании
isProject boolean нет false Создать как проект
isExtranet boolean нет false Группа экстранета
keywords string нет — Ключевые слова для поиска

Примеры

curl — личный ключ

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/workgroups" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Маркетинг 2026",
    "description": "Координация рекламных кампаний",
    "opened": true,
    "isProject": false
  }'

curl — OAuth-приложение

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/workgroups" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Маркетинг 2026",
    "description": "Координация рекламных кампаний",
    "opened": true,
    "isProject": false
  }'

JavaScript — личный ключ

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/workgroups', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    name: 'Маркетинг 2026',
    description: 'Координация рекламных кампаний',
    opened: true,
    isProject: false,
  }),
})

const { success, data } = await res.json()
console.log('Workgroup ID:', data.id)

JavaScript — OAuth-приложение

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/workgroups', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    name: 'Маркетинг 2026',
    description: 'Координация рекламных кампаний',
    opened: true,
    isProject: false,
  }),
})

const { success, data } = await res.json()

Поля ответа

Возвращается полный объект созданной рабочей группы.

Поле Тип Описание
success boolean Всегда true при успехе
data object Объект созданной рабочей группы. Полное описание полей — Получить рабочую группу или Поля рабочей группы

Пример ответа

JSON 
{
  "success": true,
  "data": {
    "id": 173,
    "siteId": "s1",
    "name": "Маркетинг 2026",
    "description": "Координация рекламных кампаний",
    "dateCreate": "2026-05-26T05:56:40.000Z",
    "dateUpdate": "2026-05-26T05:56:40.000Z",
    "active": true,
    "visible": true,
    "opened": true,
    "archived": false,
    "subjectId": 1,
    "ownerId": 1,
    "keywords": null,
    "membersCount": 1,
    "dateActivity": "2026-05-26T05:56:40.000Z",
    "subjectName": "Рабочие группы",
    "isProject": false,
    "isExtranet": false
  }
}

Пример ответа при ошибке

422 — не передано обязательное поле name:

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "Не указано название"
  }
}

Ошибки

HTTP error.code Описание
422 BITRIX_ERROR Битрикс24 отказал в создании группы — текст причины в error.message. Типичная причина: отсутствует обязательное поле name
401 MISSING_API_KEY Не передан заголовок X-Api-Key
401 INVALID_API_KEY Переданный ключ не распознан
403 SCOPE_DENIED У ключа нет скоупа sonet_group

Полный список общих ошибок API — Ошибки.

Смотрите также