Для AI-агентов: markdown этой страницы — /docs-content/scrum/epics/update.md индекс документации — /llms.txt

Обновить эпик

PATCH /v1/scrum/epics/:id

Частично обновляет эпик скрам-проекта: переименование, перекраска, смена описания или скрам-проекта. Тело плоское, без обёртки fields.

Параметры

Параметр Тип Обяз. Описание
Параметрid (path) Типnumber Обяз.да ОписаниеID эпика

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

Передавайте только изменяемые поля. Нужно хотя бы одно из перечисленных.

Поле Тип Обяз. Описание
Полеname Типstring Обяз.нет ОписаниеНовое название эпика. До 65 535 символов
ПолеgroupId Типnumber Обяз.нет ОписаниеНовый ID скрам-проекта. Список: GET /v1/workgroups
Полеdescription Типstring Обяз.нет ОписаниеНовое описание. До 65 535 символов
Полеcolor Типstring Обяз.нет ОписаниеНовый цвет эпика, например "#5eead4". До 64 символов
ПолеmodifiedBy Типnumber Обяз.нет ОписаниеID изменившего эпик. Список: GET /v1/users

Примеры

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

Terminal 
curl -X PATCH https://vibecode.bitrix24.tech/v1/scrum/epics/9 \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "doc-verify epic",
    "description": "x",
    "color": "#5eead4",
    "modifiedBy": 1
  }'

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

Terminal 
curl -X PATCH https://vibecode.bitrix24.tech/v1/scrum/epics/9 \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "doc-verify epic",
    "description": "x",
    "color": "#5eead4",
    "modifiedBy": 1
  }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/scrum/epics/9', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    name: 'doc-verify epic',
    description: 'x',
    color: '#5eead4',
    modifiedBy: 1,
  }),
})

const { data } = await res.json()

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/scrum/epics/9', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    name: 'doc-verify epic',
    description: 'x',
    color: '#5eead4',
    modifiedBy: 1,
  }),
})

const { data } = await res.json()

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean ОписаниеВсегда true при успехе
Полеdata Типobject ОписаниеЭпик после обновления
Полеdata.id Типnumber ОписаниеID эпика
Полеdata.groupId Типnumber ОписаниеID скрам-проекта
Полеdata.name Типstring ОписаниеНазвание эпика
Полеdata.description Типstring ОписаниеОписание эпика
Полеdata.color Типstring ОписаниеЦвет эпика
Полеdata.createdBy Типnumber ОписаниеID автора
Полеdata.modifiedBy Типnumber ОписаниеID последнего изменившего

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

JSON 
{
    "success": true,
    "data": {
        "id": 9,
        "groupId": 45,
        "name": "doc-verify epic",
        "description": "x",
        "createdBy": 1,
        "modifiedBy": 1,
        "color": "#5eead4"
    }
}

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

400 — нарушена валидация:

JSON 
{
    "success": false,
    "error": {
        "code": "INVALID_PARAMS",
        "message": "At least one of name, groupId, description, color, createdBy, modifiedBy is required"
    }
}

Ошибки

HTTP Код Описание
HTTP400 КодINVALID_PARAMS ОписаниеПустое тело, нечисловой id, неверный тип поля или передан createdBy
HTTP404 КодENTITY_NOT_FOUND ОписаниеЭпика с указанным id не существует
HTTP422 КодBITRIX_ERROR ОписаниеБитрикс24 вернул ошибку при обновлении эпика
HTTP403 КодSCOPE_DENIED ОписаниеКлючу не хватает скоупа task
HTTP403 КодWRITE_BLOCKED_READONLY_KEY ОписаниеКлюч работает только на чтение
HTTP401 КодTOKEN_MISSING ОписаниеУ ключа нет настроенных токенов

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

Известные особенности

createdBy задаётся только при создании. В обновлении это поле отклоняется с 400 INVALID_PARAMS и сообщением «createdBy can only be set on create». Авторство переносить нельзя — для записи изменившего используйте modifiedBy.

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