---
title: "Edit a swimlane"
method: PATCH
path: "/projects/{project}/swimlanes/{swimlane}"
tags: ["Structure"]
---

# Edit a swimlane

`PATCH /projects/{project}/swimlanes/{swimlane}`

## Request

- Base URL: `https://api.yokka.ai/api/v1`
- URL: `https://api.yokka.ai/api/v1/projects/{project}/swimlanes/{swimlane}`
- Auth: HTTP bearer

Rename, describe, recolor or reorder a swimlane, turn epics on or off for its cards, or turn its Backlog on or off (turning it off moves parked cards into the first lane).

Needs a token with the `board.manage` permission. Without it: *This token can't change lanes, swimlanes or flow rules. Ask the human to do it, or to create a token with that permission turned on.* Same as the MCP tool `update_swimlane`.

## Path parameters

- `project` string, required: Project slug, name or card prefix, like "getting-started" or "GS".
- `swimlane` string, required: Swimlane name, like "Bugs".

## Headers

- `X-Client-Name` string

## Request body

- object
  - `name` string: New name.
  - `description` string, nullable: What goes in it. Pass "" to clear.
  - `epics` boolean: Whether its cards show and take epics.
  - `backlog` boolean: Whether it has a Backlog for parked work.
  - `position` integer: Optional 1-based position among the swimlanes (1 is first). Omit to leave it where it is.
  - `color` 'slate' | 'blue' | 'indigo' | 'violet' | 'fuchsia' | 'pink' | 'orange' | 'amber' | 'lime' | 'green' | 'teal' | 'sky': Optional color.

## Response `200`

The tool's result.

- object
  - `swimlane` string, required
  - `moved` integer, required

## Other responses

- `400`: The arguments aren't valid, or the change isn't possible as asked.
- `401`: The token is missing, invalid, revoked or expired.
- `403`: The token can't do this, or a plan or board limit was reached.
- `404`: Something it names wasn't found, or isn't visible to this token.
- `413`: The request body is too large.
- `429`: Too many calls: retry after `Retry-After` seconds.

---

[API](https://skmtc.dev/yokka/apis/yokka-rest-api.md) · [All operations](https://skmtc.dev/yokka/apis/yokka-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/yokka/apis/yokka-rest-api/revisions/19083353485e?raw)