## Сохранить настройки DoD

`POST /v1/scrum/groups/:groupId/dod/types/:typeId/settings`

Задаёт для типа Definition of Done скрам-проекта обязательность чек-листа, его пункты и участников типа. Пункты и участники заменяются целиком значениями из запроса.

## Параметры

| Параметр | Тип | Обяз. | Описание |
|----------|-----|-------|----------|
| `groupId` (path) | number | да | ID скрам-проекта. Список: [`GET /v1/workgroups`](/docs/entities/workgroups/list) |
| `typeId` (path) | number | да | ID типа DoD. Список: [`GET /v1/scrum/groups/:groupId/dod/settings`](/docs/scrum/dod/settings), поле `data.types[].id` |

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

| Поле | Тип | Обяз. | Описание |
|------|-----|-------|----------|
| `requiredOption` | string | да | `Y` — чек-лист DoD обязателен для задач типа, `N` — нет |
| `items` | array | да | Пункты чек-листа типа. Пустой массив удаляет все пункты |
| `items[].TITLE` | string | да | Текст пункта. Имя поля — в верхнем регистре |
| `participants` | array | да | Участники типа. Пустой массив удаляет всех участников |
| `participants[].entityId` | string | да | `user` |
| `participants[].id` | number | да | ID сотрудника. Список: [`GET /v1/users`](/docs/entities/users/list) |

## Примеры

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

```bash
curl -X POST "https://vibecode.bitrix24.tech/v1/scrum/groups/53/dod/types/7/settings" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "requiredOption": "Y",
    "items": [{ "TITLE": "Код прошёл ревью" }, { "TITLE": "Тесты пройдены" }],
    "participants": [{ "entityId": "user", "id": 1 }]
  }'
```

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

```bash
curl -X POST "https://vibecode.bitrix24.tech/v1/scrum/groups/53/dod/types/7/settings" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "requiredOption": "Y",
    "items": [{ "TITLE": "Код прошёл ревью" }, { "TITLE": "Тесты пройдены" }],
    "participants": [{ "entityId": "user", "id": 1 }]
  }'
```

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/scrum/groups/53/dod/types/7/settings', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    requiredOption: 'Y',
    items: [{ TITLE: 'Код прошёл ревью' }, { TITLE: 'Тесты пройдены' }],
    participants: [{ entityId: 'user', id: 1 }],
  }),
})

const { data } = await res.json()
console.log(data.type.dodRequired)
```

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/scrum/groups/53/dod/types/7/settings', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    requiredOption: 'Y',
    items: [{ TITLE: 'Код прошёл ревью' }, { TITLE: 'Тесты пройдены' }],
    participants: [{ entityId: 'user', id: 1 }],
  }),
})

const { data } = await res.json()
console.log(data.type.dodRequired)
```

## Поля ответа

| Поле | Тип | Описание |
|------|-----|----------|
| `success` | boolean | Всегда `true` при успехе |
| `data.type.id` | number | ID типа DoD |
| `data.type.entityId` | number | ID бэклога скрам-проекта, к которому относится тип |
| `data.type.name` | string | Название типа |
| `data.type.sort` | number | Порядок типа в списке |
| `data.type.dodRequired` | string | Сохранённое значение `requiredOption` |
| `data.type.participants` | array | Сохранённые участники в формате `{ "id": 1, "entityId": "user" }` |

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

```json
{
  "success": true,
  "data": {
    "type": {
      "id": 7,
      "entityId": 5,
      "name": "Техническая задача",
      "sort": 2,
      "dodRequired": "Y",
      "participants": [
        {
          "id": 1,
          "entityId": "user"
        }
      ]
    }
  }
}
```

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

422 — типа с таким `typeId` нет:

```json
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "Не удалось найти тип.",
    "b24Code": "TASKS_SDC_03"
  }
}
```

## Ошибки

| HTTP | Код | Описание |
|------|-----|----------|
| 400 | `INVALID_PARAMS` | `groupId` или `typeId` не является положительным целым числом |
| 400 | `INVALID_PARAMS` | `requiredOption` не передан или не равен `Y` или `N` |
| 400 | `INVALID_PARAMS` | `items` или `participants` не передан или не является массивом |
| 400 | `INVALID_PARAMS` | Тело не является JSON-объектом, например передан массив |
| 400 | `INVALID_PARAMS` | В теле есть поле кроме `requiredOption`, `items` и `participants` |
| 400 | `FST_ERR_CTP_EMPTY_JSON_BODY` | Запрос с `Content-Type: application/json` и пустым телом |
| 401 | `MISSING_API_KEY` | Не передан `X-Api-Key` |
| 401 | `TOKEN_MISSING` | У ключа нет настроенных токенов |
| 403 | `SCOPE_DENIED` | Ключу не хватает скоупа `task` |
| 403 | `WRITE_BLOCKED_READONLY_KEY` | Ключ работает в режиме только чтения |
| 422 | `BITRIX_ERROR` | Типа с таким `typeId` нет. В `error.b24Code` — `TASKS_SDC_03`, сообщение «Не удалось найти тип.» |
| 422 | `BITRIX_ERROR` | Пункт `items` без поля `TITLE`, например с `title` в нижнем регистре. В `error.b24Code` — `TASKS_SDC_03`, сообщение «System error» |
| 422 | `BITRIX_ERROR` | Пункт `items` — строка, а не объект. В `error.b24Code` — `0`, сообщение «Internal server error.» |
| 422 | `BITRIX_ERROR` | Проект не существует или у пользователя нет к нему доступа. В `error.b24Code` — `TASKS_SDC_02` |

Полный список общих ошибок API — [Ошибки](/docs/errors).

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

- Участник с `"entityId": "department"` не сохраняется: запрос отвечает успехом, а `data.type.participants` в ответе пустой. Сохранённых участников сверяйте по ответу.

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

- [Получить настройки DoD](/docs/scrum/dod/settings)
- [Сохранить список DoD задачи](/docs/scrum/dod/save-list)
- [Definition of Done в Scrum](/docs/scrum/dod)
- [Список сотрудников](/docs/entities/users/list)
