---
title: "PATCH /api/backlog_items/{id}"
method: PATCH
path: "/api/backlog_items/{id}"
tags: ["Backlog Items"]
---

# PATCH /api/backlog_items/{id}

`PATCH /api/backlog_items/{id}`

## Request

- Base URL: `https://api.atono.io`
- URL: `https://api.atono.io/api/backlog_items/{id}`
- Auth: API key in header `X-API-KEY`

## Path parameters

- `id` string, required

## Request body

- RequestBacklogItemUpdateResource
  - `data` BacklogItemUpdateResource, required
    - `type` string, required
    - `id` string, uuid, required
    - `attributes` BacklogItemUpdateResourceBacklogItemAttributes, required
      - `title` string, nullable, required
      - `position` integer, nullable, required
      - `triage` 'NOT_TRIAGED' | 'TRIAGED' | 'REJECTED' | 'INFO_REQUIRED', required
      - `content` ContentChunk[], nullable, required
        - `type` 'DISPLAY_HTML' | 'TEXT' | 'PERSONA', required: The type of content chunk. - `DISPLAY_HTML`: HTML-formatted content. - `TEXT`: Plain text content. - `PERSONA`: A persona for a user story.
        - `value` string, required: The content in this chunk.
      - `additionalContent` ContentChunk[], nullable, required
        - `type` 'DISPLAY_HTML' | 'TEXT' | 'PERSONA', required: The type of content chunk. - `DISPLAY_HTML`: HTML-formatted content. - `TEXT`: Plain text content. - `PERSONA`: A persona for a user story.
        - `value` string, required: The content in this chunk.
      - `cycleTimeMode` 'NORMAL' | 'OUTLIER', required
      - `stalenessIndicatorSnoozeUntil` string, date-time, nullable, required
      - `restoreVersion` string, uuid, nullable, required
      - `sizingMode` 'MANUAL' | 'USE_SUGGESTION', required
      - `epicPosition` integer, nullable, required
      - `aiAgentName` string, nullable, required
    - `relationships` BacklogItemUpdateResourceBacklogItemRelationships, required
      - `assignee` SingleRelationshipUpdate, required
        - `data` ResourceIdentifier, required
          - `type` string, required: Identifies the type of the linked resource.
          - `id` string, required: The unique identifier of the linked resource.
      - `creator` SingleRelationshipUpdate, required
        - `data` ResourceIdentifier, required
          - `type` string, required: Identifies the type of the linked resource.
          - `id` string, required: The unique identifier of the linked resource.
      - `team` SingleRelationshipUpdate, required
        - `data` ResourceIdentifier, required
          - `type` string, required: Identifies the type of the linked resource.
          - `id` string, required: The unique identifier of the linked resource.
      - `acceptanceCriteria` AcceptanceCriteriaReplaceResource, required
        - `data` AcceptanceCriterionUpdateResource[], required
          - `type` string, required: Identifies the type of resource.
          - `id` string, uuid, nullable: ID of the acceptance criterion to update. If `null`, a new criterion will be created. Preserving the ID is important when tracking usage metrics for individual criteria.
          - `attributes` AcceptanceCriterionUpdateResourceAcceptanceCriterionBacklogItemAttributes: Contains the structured data fields that describe the resource, such as properties, settings, and timestamps.
            - `description` string, nullable: Description of the acceptance criterion.
            - `position` integer, nullable: The desired position of this acceptance criterion in the list. The first AC is at position `0`. Atono will attempt to insert the AC at this position, but the actual result may vary depending on the existing structure. For example, if no other criteria exist, the item will be added at position 0 regardless of the value provided.
            - `level` integer, nullable: The desired nesting level of the criterion. Level `0` indicates a root level criterion; higher values represent subcriteria.
            - `aiAgentName` string, nullable, required
      - `featureFlag` SingleRelationshipUpdate, required
        - `data` ResourceIdentifier, required
          - `type` string, required: Identifies the type of the linked resource.
          - `id` string, required: The unique identifier of the linked resource.
      - `impact` SingleRelationshipUpdate, required
        - `data` ResourceIdentifier, required
          - `type` string, required: Identifies the type of the linked resource.
          - `id` string, required: The unique identifier of the linked resource.
      - `probability` SingleRelationshipUpdate, required
        - `data` ResourceIdentifier, required
          - `type` string, required: Identifies the type of the linked resource.
          - `id` string, required: The unique identifier of the linked resource.
      - `size` SingleRelationshipUpdate, required
        - `data` ResourceIdentifier, required
          - `type` string, required: Identifies the type of the linked resource.
          - `id` string, required: The unique identifier of the linked resource.
      - `environments` MultipleRelationshipsUpdate, required
        - `data` ResourceIdentifier[], required
          - `type` string, required: Identifies the type of the linked resource.
          - `id` string, required: The unique identifier of the linked resource.
      - `workflowStep` SingleRelationshipUpdate, required
        - `data` ResourceIdentifier, required
          - `type` string, required: Identifies the type of the linked resource.
          - `id` string, required: The unique identifier of the linked resource.
      - `linkedItems` MultipleRelationshipsUpdate, required
        - `data` ResourceIdentifier[], required
          - `type` string, required: Identifies the type of the linked resource.
          - `id` string, required: The unique identifier of the linked resource.
      - `timebox` SingleRelationshipUpdate, required
        - `data` ResourceIdentifier, required
          - `type` string, required: Identifies the type of the linked resource.
          - `id` string, required: The unique identifier of the linked resource.
      - `sprint` SingleRelationshipUpdate, required
        - `data` ResourceIdentifier, required
          - `type` string, required: Identifies the type of the linked resource.
          - `id` string, required: The unique identifier of the linked resource.
      - `productTheme` SingleRelationshipUpdate, required
        - `data` ResourceIdentifier, required
          - `type` string, required: Identifies the type of the linked resource.
          - `id` string, required: The unique identifier of the linked resource.
      - `epic` SingleRelationshipUpdate, required
        - `data` ResourceIdentifier, required
          - `type` string, required: Identifies the type of the linked resource.
          - `id` string, required: The unique identifier of the linked resource.

## Response `200`

updateBacklogItem 200 response

- SingleResourceBodyBacklogItemResource
  - `data` BacklogItemResource
    - `type` string, required
    - `id` string, uuid, required
    - `attributes` BacklogItemResourceBacklogItemAttributes, required
      - `title` string, required
      - `handle` string, required
      - `position` integer, required
      - `deleted` boolean, required
      - `itemType` 'STORY' | 'BUG' | 'TASK' | 'VULNERABILITY' | 'EPIC', required
      - `createdAt` string, date-time, required
      - `updatedAt` string, date-time, required
      - `triage` 'NOT_TRIAGED' | 'TRIAGED' | 'REJECTED' | 'INFO_REQUIRED', required
      - `cycleTimeMode` 'NORMAL' | 'OUTLIER', required
      - `stalenessIndicatorSnoozeUntil` string, date-time, required
      - `doneAt` string, date-time, required
      - `externalId` string, required
      - `content` ContentChunk[], nullable, required
        - `type` 'DISPLAY_HTML' | 'TEXT' | 'PERSONA', required: The type of content chunk. - `DISPLAY_HTML`: HTML-formatted content. - `TEXT`: Plain text content. - `PERSONA`: A persona for a user story.
        - `value` string, required: The content in this chunk.
      - `additionalContent` ContentChunk[], nullable, required
        - `type` 'DISPLAY_HTML' | 'TEXT' | 'PERSONA', required: The type of content chunk. - `DISPLAY_HTML`: HTML-formatted content. - `TEXT`: Plain text content. - `PERSONA`: A persona for a user story.
        - `value` string, required: The content in this chunk.
      - `sizingMode` 'MANUAL' | 'USE_SUGGESTION', required
      - `epicPosition` integer, nullable, required
    - `relationships` BacklogItemResourceBacklogItemRelationships, required
      - `creator` SingleRelationship, required
        - `links` RelationshipLinks, required
          - `self` string, uri, nullable, required
          - `related` string, uri, nullable, required
        - `data` ResourceIdentifier, required
          - `type` string, required: Identifies the type of the linked resource.
          - `id` string, required: The unique identifier of the linked resource.
        - `meta` unknown, required
      - `workflowStep` SingleRelationship, required
        - `links` RelationshipLinks, required
          - `self` string, uri, nullable, required
          - `related` string, uri, nullable, required
        - `data` ResourceIdentifier, required
          - `type` string, required: Identifies the type of the linked resource.
          - `id` string, required: The unique identifier of the linked resource.
        - `meta` unknown, required
      - `assignee` SingleRelationship, required
        - `links` RelationshipLinks, required
          - `self` string, uri, nullable, required
          - `related` string, uri, nullable, required
        - `data` ResourceIdentifier, required
          - `type` string, required: Identifies the type of the linked resource.
          - `id` string, required: The unique identifier of the linked resource.
        - `meta` unknown, required
      - `acceptanceCriteria` MultipleRelationships, required
        - `links` RelationshipLinks, required
          - `self` string, uri, nullable, required
          - `related` string, uri, nullable, required
        - `data` ResourceIdentifier[], nullable, required
          - `type` string, required: Identifies the type of the linked resource.
          - `id` string, required: The unique identifier of the linked resource.
        - `meta` unknown, required
      - `attachments` MultipleRelationships, required
        - `links` RelationshipLinks, required
          - `self` string, uri, nullable, required
          - `related` string, uri, nullable, required
        - `data` ResourceIdentifier[], nullable, required
          - `type` string, required: Identifies the type of the linked resource.
          - `id` string, required: The unique identifier of the linked resource.
        - `meta` unknown, required
      - `comments` MultipleRelationships, required
        - `links` RelationshipLinks, required
          - `self` string, uri, nullable, required
          - `related` string, uri, nullable, required
        - `data` ResourceIdentifier[], nullable, required
          - `type` string, required: Identifies the type of the linked resource.
          - `id` string, required: The unique identifier of the linked resource.
        - `meta` unknown, required
      - `featureFlag` SingleRelationship, required
        - `links` RelationshipLinks, required
          - `self` string, uri, nullable, required
          - `related` string, uri, nullable, required
        - `data` ResourceIdentifier, required
          - `type` string, required: Identifies the type of the linked resource.
          - `id` string, required: The unique identifier of the linked resource.
        - `meta` unknown, required
      - `team` SingleRelationship, required
        - `links` RelationshipLinks, required
          - `self` string, uri, nullable, required
          - `related` string, uri, nullable, required
        - `data` ResourceIdentifier, required
          - `type` string, required: Identifies the type of the linked resource.
          - `id` string, required: The unique identifier of the linked resource.
        - `meta` unknown, required
      - `impact` SingleRelationship, required
        - `links` RelationshipLinks, required
          - `self` string, uri, nullable, required
          - `related` string, uri, nullable, required
        - `data` ResourceIdentifier, required
          - `type` string, required: Identifies the type of the linked resource.
          - `id` string, required: The unique identifier of the linked resource.
        - `meta` unknown, required
      - `probability` SingleRelationship, required
        - `links` RelationshipLinks, required
          - `self` string, uri, nullable, required
          - `related` string, uri, nullable, required
        - `data` ResourceIdentifier, required
          - `type` string, required: Identifies the type of the linked resource.
          - `id` string, required: The unique identifier of the linked resource.
        - `meta` unknown, required
      - `size` SingleRelationship, required
        - `links` RelationshipLinks, required
          - `self` string, uri, nullable, required
          - `related` string, uri, nullable, required
        - `data` ResourceIdentifier, required
          - `type` string, required: Identifies the type of the linked resource.
          - `id` string, required: The unique identifier of the linked resource.
        - `meta` unknown, required
      - `environments` MultipleRelationships, required
        - `links` RelationshipLinks, required
          - `self` string, uri, nullable, required
          - `related` string, uri, nullable, required
        - `data` ResourceIdentifier[], nullable, required
          - `type` string, required: Identifies the type of the linked resource.
          - `id` string, required: The unique identifier of the linked resource.
        - `meta` unknown, required
      - `linkedItems` MultipleRelationships, required
        - `links` RelationshipLinks, required
          - `self` string, uri, nullable, required
          - `related` string, uri, nullable, required
        - `data` ResourceIdentifier[], nullable, required
          - `type` string, required: Identifies the type of the linked resource.
          - `id` string, required: The unique identifier of the linked resource.
        - `meta` unknown, required
      - `timebox` SingleRelationship, required
        - `links` RelationshipLinks, required
          - `self` string, uri, nullable, required
          - `related` string, uri, nullable, required
        - `data` ResourceIdentifier, required
          - `type` string, required: Identifies the type of the linked resource.
          - `id` string, required: The unique identifier of the linked resource.
        - `meta` unknown, required
      - `sprint` SingleRelationship, required
        - `links` RelationshipLinks, required
          - `self` string, uri, nullable, required
          - `related` string, uri, nullable, required
        - `data` ResourceIdentifier, required
          - `type` string, required: Identifies the type of the linked resource.
          - `id` string, required: The unique identifier of the linked resource.
        - `meta` unknown, required
      - `productTheme` SingleRelationship, required
        - `links` RelationshipLinks, required
          - `self` string, uri, nullable, required
          - `related` string, uri, nullable, required
        - `data` ResourceIdentifier, required
          - `type` string, required: Identifies the type of the linked resource.
          - `id` string, required: The unique identifier of the linked resource.
        - `meta` unknown, required
      - `vcsPullRequests` MultipleRelationships, required
        - `links` RelationshipLinks, required
          - `self` string, uri, nullable, required
          - `related` string, uri, nullable, required
        - `data` ResourceIdentifier[], nullable, required
          - `type` string, required: Identifies the type of the linked resource.
          - `id` string, required: The unique identifier of the linked resource.
        - `meta` unknown, required
      - `epic` SingleRelationship, required
        - `links` RelationshipLinks, required
          - `self` string, uri, nullable, required
          - `related` string, uri, nullable, required
        - `data` ResourceIdentifier, required
          - `type` string, required: Identifies the type of the linked resource.
          - `id` string, required: The unique identifier of the linked resource.
        - `meta` unknown, required
      - `epicStories` MultipleRelationships, required
        - `links` RelationshipLinks, required
          - `self` string, uri, nullable, required
          - `related` string, uri, nullable, required
        - `data` ResourceIdentifier[], nullable, required
          - `type` string, required: Identifies the type of the linked resource.
          - `id` string, required: The unique identifier of the linked resource.
        - `meta` unknown, required
      - `subtasks` MultipleRelationships, required
        - `links` RelationshipLinks, required
          - `self` string, uri, nullable, required
          - `related` string, uri, nullable, required
        - `data` ResourceIdentifier[], nullable, required
          - `type` string, required: Identifies the type of the linked resource.
          - `id` string, required: The unique identifier of the linked resource.
        - `meta` unknown, required
      - `tagValues` MultipleRelationships, required
        - `links` RelationshipLinks, required
          - `self` string, uri, nullable, required
          - `related` string, uri, nullable, required
        - `data` ResourceIdentifier[], nullable, required
          - `type` string, required: Identifies the type of the linked resource.
          - `id` string, required: The unique identifier of the linked resource.
        - `meta` unknown, required
    - `meta` BacklogItemResourceBacklogItemMetadata, required
      - `state` 'REGULAR' | 'SAMPLE_DATA' | 'JIRA_SYNC', required: Represents the state of an entity in the system.
      - `riskRating` BacklogItemRiskRating, required
        - `rating` integer, required
        - `impact` integer, required
        - `probability` integer, required
      - `allowedActions` string[], required
      - `isFollowedItem` boolean, nullable, required
      - `subtaskCount` BacklogItemResourceSubtaskCount, required
        - `undone` integer, required
      - `syncDate` string, date-time, nullable, required
      - `syncStatus` 'IN_PROGRESS' | 'COMPLETED' | 'FAILED' | 'JIRA_NEWER' | 'UNSYNCED', required
      - `jiraUpdatedAt` string, date-time, nullable, required
  - `errors` ProblemDetail[]: A list of errors returned with the response, if the request could not be completed. Each object includes details about a specific issue.
    - `id` string: A unique identifier for this specific error occurrence. Useful for debugging and support.
    - `links` object, nullable: Links related to the error. May include a URL to relevant documentation or support resources.
    - `status` integer: The HTTP status code associated with the error (e.g., 400, 404, 422).
    - `code` string: An internal code that identifies the type or category of the error.
    - `title` string: A short summary of the problem.
    - `source` ProblemSource: Identifies the part of the request that caused the error. Only one source is present per error.
      - `pointer` string, nullable: Specifies the path to the field in the request body that caused the error.
      - `parameter` string, nullable: Identifies a query parameter in the request URL that caused the error.
      - `header` string, nullable: Identifies the request header that caused the error.
    - `detail` string: Additional information about the error, intended to provide more context than the title.
    - `meta` unknown
  - `meta` unknown
  - `included` unknown[]: A list of related resources included in the response, either automatically by the API or in response to an include parameter in the request. Each item contains a full resource object (e.g., users, teams, acceptance criteria).
    - unknown
  - `links` unknown

---

[API](https://skmtc.dev/atono/apis/backend-api.md) · [All operations](https://skmtc.dev/atono/apis/backend-api/llms.txt) · [OpenAPI document](https://skmtc.dev/atono/apis/backend-api/revisions/78a57b1d8c3d?raw)