For AI agents: markdown of this page — /docs-content-en/scrum/dod/save-settings.md documentation index — /llms.txt
Save DoD settings
POST /v1/scrum/groups/:groupId/dod/types/:typeId/settings
Sets whether the checklist is required, the checklist items, and the participants of a Definition of Done type in a Scrum project. Items and participants are replaced entirely with the values from the request.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
ParametergroupId (path) |
Typenumber | Requiredyes | DescriptionScrum project ID. List: GET /v1/workgroups |
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 |
|---|---|---|---|
FieldrequiredOption |
Typestring | Requiredyes | DescriptionY — the DoD checklist is required for tasks of this type, N — it is not |
Fielditems |
Typearray | Requiredyes | DescriptionChecklist items of the type. An empty array deletes all items |
Fielditems[].TITLE |
Typestring | Requiredyes | DescriptionItem text. The field name is uppercase |
Fieldparticipants |
Typearray | Requiredyes | DescriptionParticipants of the type. An empty array deletes all participants |
Fieldparticipants[].entityId |
Typestring | Requiredyes | Descriptionuser |
Fieldparticipants[].id |
Typenumber | Requiredyes | DescriptionEmployee ID. List: GET /v1/users |
Examples
curl — personal key
curl -X POST "https://vibecode.bitrix24.com/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": "Code reviewed" }, { "TITLE": "Tests passed" }],
"participants": [{ "entityId": "user", "id": 1 }]
}'
curl — OAuth application
curl -X POST "https://vibecode.bitrix24.com/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": "Code reviewed" }, { "TITLE": "Tests passed" }],
"participants": [{ "entityId": "user", "id": 1 }]
}'
JavaScript — personal key
const res = await fetch('https://vibecode.bitrix24.com/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: 'Code reviewed' }, { TITLE: 'Tests passed' }],
participants: [{ entityId: 'user', id: 1 }],
}),
})
const { data } = await res.json()
console.log(data.type.dodRequired)
JavaScript — OAuth application
const res = await fetch('https://vibecode.bitrix24.com/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: 'Code reviewed' }, { TITLE: 'Tests passed' }],
participants: [{ entityId: 'user', id: 1 }],
}),
})
const { data } = await res.json()
console.log(data.type.dodRequired)
Response fields
| Field | Type | Description |
|---|---|---|
Fieldsuccess |
Typeboolean | DescriptionAlways true on success |
Fielddata.type.id |
Typenumber | DescriptionDoD type ID |
Fielddata.type.entityId |
Typenumber | DescriptionID of the Scrum project backlog the type belongs to |
Fielddata.type.name |
Typestring | DescriptionType name |
Fielddata.type.sort |
Typenumber | DescriptionPosition of the type in the list |
Fielddata.type.dodRequired |
Typestring | DescriptionSaved value of requiredOption |
Fielddata.type.participants |
Typearray | DescriptionSaved participants in the format { "id": 1, "entityId": "user" } |
Response example
{
"success": true,
"data": {
"type": {
"id": 7,
"entityId": 5,
"name": "Technical task",
"sort": 2,
"dodRequired": "Y",
"participants": [
{
"id": 1,
"entityId": "user"
}
]
}
}
}
Error response example
422 — no type with this typeId:
{
"success": false,
"error": {
"code": "BITRIX_ERROR",
"message": "Could not find the type.",
"b24Code": "TASKS_SDC_03"
}
}
Errors
| HTTP | Code | Description |
|---|---|---|
| HTTP400 | CodeINVALID_PARAMS |
DescriptiongroupId or typeId is not a positive integer |
| HTTP400 | CodeINVALID_PARAMS |
DescriptionrequiredOption is not passed or is not Y or N |
| HTTP400 | CodeINVALID_PARAMS |
Descriptionitems or participants is not passed or is not an array |
| HTTP400 | CodeINVALID_PARAMS |
DescriptionThe body is not a JSON object, for example an array |
| HTTP400 | CodeINVALID_PARAMS |
DescriptionThe body contains a field other than requiredOption, items, and participants |
| 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 |
DescriptionAn items entry without the TITLE field, for example with lowercase title. error.b24Code is TASKS_SDC_03, message "System error" |
| HTTP422 | CodeBITRIX_ERROR |
DescriptionAn items entry is a string, not an object. error.b24Code is 0, message "Internal server error." |
| HTTP422 | CodeBITRIX_ERROR |
DescriptionThe project does not exist or the user has no access to it. error.b24Code is TASKS_SDC_02 |
Full list of common API errors — Errors.
Known specifics
- A participant with
"entityId": "department"is not saved: the request returns success, butdata.type.participantsin the response is empty. Check the saved participants against the response.