For AI agents: markdown of this page — /docs-content-en/scrum/dod/save-list.md documentation index — /llms.txt

Save a task's DoD list

POST /v1/scrum/tasks/:taskId/dod/:typeId

Writes the Definition of Done checklist items for a Scrum project task under the selected DoD type. The task's saved list is replaced with the items from the request.

Parameters

Parameter Type Required Description
ParametertaskId (path) Typenumber Requiredyes DescriptionTask ID. Project task list: GET /v1/tasks?filter[groupId]=53
ParametertypeId (path) Typenumber Requiredyes DescriptionDoD type ID. List: GET /v1/scrum/groups/:groupId/dod/settings, field data.types[].id

Request fields (body)

Field Type Required Description
Fielditems Typearray Requiredyes DescriptionThe task's checklist items. An empty array clears the list
Fielditems[].TITLE Typestring Requiredyes DescriptionItem text. The field name is uppercase

Examples

curl — personal key

Terminal
curl -X POST "https://vibecode.bitrix24.com/v1/scrum/tasks/3671/dod/7" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "items": [
      { "TITLE": "Code reviewed" },
      { "TITLE": "Tests passed" }
    ]
  }'

curl — OAuth application

Terminal
curl -X POST "https://vibecode.bitrix24.com/v1/scrum/tasks/3671/dod/7" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "items": [
      { "TITLE": "Code reviewed" },
      { "TITLE": "Tests passed" }
    ]
  }'

JavaScript — personal key

javascript
const res = await fetch('https://vibecode.bitrix24.com/v1/scrum/tasks/3671/dod/7', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    items: [
      { TITLE: 'Code reviewed' },
      { TITLE: 'Tests passed' },
    ],
  }),
})

const { success } = await res.json()
console.log(success)

JavaScript — OAuth application

javascript
const res = await fetch('https://vibecode.bitrix24.com/v1/scrum/tasks/3671/dod/7', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    items: [
      { TITLE: 'Code reviewed' },
      { TITLE: 'Tests passed' },
    ],
  }),
})

const { success } = await res.json()
console.log(success)

Response fields

Field Type Description
Fieldsuccess Typeboolean DescriptionAlways true on success
Fielddata Typestring DescriptionEmpty string

Response example

JSON
{
  "success": true,
  "data": ""
}

Error response example

422 — no type with this typeId:

JSON
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "Could not find the type.",
    "b24Code": "TASKS_SDC_03"
  }
}

Errors

HTTP Code Description
HTTP400 CodeINVALID_PARAMS DescriptiontaskId or typeId is not a positive integer
HTTP400 CodeINVALID_PARAMS Descriptionitems is not passed or is not an array
HTTP400 CodeINVALID_PARAMS DescriptionThe body is not a JSON object or contains a field other than items
HTTP400 CodeFST_ERR_CTP_EMPTY_JSON_BODY DescriptionRequest with Content-Type: application/json and an empty body
HTTP401 CodeMISSING_API_KEY DescriptionX-Api-Key is not passed
HTTP401 CodeTOKEN_MISSING DescriptionThe key has no configured tokens
HTTP403 CodeSCOPE_DENIED DescriptionThe key lacks the task scope
HTTP403 CodeWRITE_BLOCKED_READONLY_KEY DescriptionThe key is in read-only mode
HTTP422 CodeBITRIX_ERROR DescriptionNo type with this typeId. error.b24Code is TASKS_SDC_03, message "Could not find the type."
HTTP422 CodeBITRIX_ERROR DescriptionNo task with this taskId, or an items entry without the TITLE field. error.b24Code is TASKS_SDC_05, message "Error saving the list"

Full list of common API errors — Errors.

Known specifics

  • The API does not check whether the type belongs to the task's project: the list is saved even with the typeId of a type from another Scrum project. Take the type ID from the DoD settings of the project that contains the task.

See also