---
title: "Update a workflow step"
method: PATCH
path: "/api/workflows/steps/{stepId}"
tags: ["Workflows"]
---

# Update a workflow step

`PATCH /api/workflows/steps/{stepId}`

## Request

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

## Path parameters

- `stepId` string, uuid, required

## Request body

- RequestWorkflowStepUpdateResource
  - `data` WorkflowStepUpdateResource, required
    - `type` string, required
    - `id` string, uuid, required
    - `attributes` WorkflowStepUpdateResourceWorkflowAttributes, required
      - `name` string, nullable, required
      - `color` string, nullable, required
      - `category` 'TODO' | 'IN_PROGRESS' | 'DONE' | 'WONT_DO', required: The category of the workflow step. Valid values are `TODO` (To do), `IN_PROGRESS` (In progress), `DONE` (Done), or `WONT_DO` (Won't do). The category determines the general stage of work items in this step.
      - `position` integer, nullable, required
      - `forStory` boolean, nullable, required
      - `forBug` boolean, nullable, required

## Response `200`

updateWorkflowStep 200 response

- SingleResourceBodyWorkflowStepResource
  - `data` WorkflowStepResource
    - `type` string, required
    - `id` string, uuid, required
    - `attributes` WorkflowStepResourceWorkflowAttributes, required
      - `position` integer, required
      - `color` string, required
      - `name` string, required
      - `category` 'TODO' | 'IN_PROGRESS' | 'DONE' | 'WONT_DO', required: The category of the workflow step. Valid values are `TODO` (To do), `IN_PROGRESS` (In progress), `DONE` (Done), or `WONT_DO` (Won't do). The category determines the general stage of work items in this step.
      - `stepType` 'TODO' | 'DESIGN' | 'DEV' | 'TEST' | 'REVIEW' | 'DONE' | 'WONTDO' | 'REPORTED' | 'INFO_REQUIRED' | 'CUSTOM', required: The high-level classification of the workflow step. Determines the default color shown in the Atono application if no custom color is set, and helps identify the most appropriate step to move items to when a step is deleted or the workflow is reset.
      - `forStory` boolean, required
      - `forBug` boolean, required
      - `allowNewItems` boolean, required
    - `relationships` WorkflowStepResourceWorkflowRelationships, required
      - `workflow` 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
      - `backlogItems` 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` WorkflowStepResourceMetadata, required
      - `storyCount` integer, required
      - `bugCount` integer, 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)