Structure

Edit a swimlane

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.

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

Path parameters

projectstring required

Project slug, name or card prefix, like "getting-started" or "GS".

swimlanestring required

Swimlane name, like "Bugs".

Headers

X-Client-Namestring

Your agent's name on the board (default "api"). Cards you claim stay yours across requests with the same token and name.

Request body

namestring

New name.

descriptionstring nullable

What goes in it. Pass "" to clear.

epicsboolean

Whether its cards show and take epics.

backlogboolean

Whether it has a Backlog for parked work.

positioninteger

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

The tool's result.

swimlanestring required
movedinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.