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

Update a backlog

PATCH /v1/scrum/backlogs/:id

Changes the fields of a Scrum project backlog. Partial update — pass only what changes.

Parameters

Parameter Type Required Description
Parameterid (path) Typenumber Requiredyes DescriptionBacklog ID, not the group ID. Where to get it — Scrum backlogs

Request fields (body)

Field Type Required Description
FieldgroupId Typenumber Requiredno DescriptionScrum project ID. Group list: GET /v1/workgroups
FieldcreatedBy Typenumber Requiredno DescriptionCreator user ID. List: GET /v1/users
FieldmodifiedBy Typenumber Requiredno DescriptionID of the user who modified the backlog. List: GET /v1/users

At least one field is required.

Examples

curl — personal key

Terminal 
curl -X PATCH https://vibecode.bitrix24.com/v1/scrum/backlogs/43 \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "modifiedBy": 1 }'

curl — OAuth application

Terminal 
curl -X PATCH https://vibecode.bitrix24.com/v1/scrum/backlogs/43 \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "modifiedBy": 1 }'

JavaScript — personal key

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/scrum/backlogs/43', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ modifiedBy: 1 }),
})

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

JavaScript — OAuth application

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/scrum/backlogs/43', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ modifiedBy: 1 }),
})

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

Response fields

Field Type Description
Fieldsuccess Typeboolean Descriptiontrue on successful update
Fielddata.id Typenumber DescriptionBacklog ID
Fielddata.groupId Typenumber DescriptionScrum project ID
Fielddata.createdBy Typenumber DescriptionCreator user ID
Fielddata.modifiedBy Typenumber DescriptionID of the user who modified the backlog

Response example

JSON 
{
  "success": true,
  "data": {
    "id": 43,
    "groupId": 175,
    "createdBy": 1,
    "modifiedBy": 1
  }
}

Error response example

404 — no backlog with this ID exists:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Backlog not found"
  }
}

Errors

HTTP Code Description
HTTP400 CodeINVALID_PARAMS DescriptionEmpty body, a field not listed in the table, or an ID that is not a positive integer
HTTP404 CodeENTITY_NOT_FOUND DescriptionNo backlog with this id exists
HTTP422 CodeBITRIX_ERROR DescriptioncreatedBy user not found — no user with this ID exists
HTTP403 CodeSCOPE_DENIED DescriptionThe key lacks the task scope
HTTP403 CodeWRITE_BLOCKED_READONLY_KEY DescriptionThe key is read-only
HTTP401 CodeTOKEN_MISSING DescriptionThe key has no configured tokens

Full list of common API errors — Errors.

See also