Structure

Edit a flow rule

Change a flow rule by its id (from get_flow_rules): its event, target lane ("" to stop moving), flag ("" to stop flagging), order, or switch it on or off. A rule that starts runs on a runner changes only in the app, by the runner's owner or an admin; you can still move it in the list.

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_flow_rule.

patch/flow-rules/{rule}

Request

  • Base URL: https://api.yokka.ai/api/v1
  • URL: https://api.yokka.ai/api/v1/flow-rules/{rule}
  • Auth: HTTP bearer

Path parameters

rulestring required

The flow rule's id, from GET /projects/{project}/flow-rules.

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

on'claimed' | 'progress' | 'needs_input' | 'answered' | 'completed' | 'released' | 'stale' | 'pr_opened' | 'pr_merged' | 'pr_closed'

The event that triggers it.

moveTostring nullable

Lane in the same swimlane, or "" for none.

setAttention'owner' | 'problem' | 'clear' | '' nullable

owner, problem, clear, or "" for none.

enabledboolean

Switch it on or off.

positioninteger

Optional 1-based position among the swimlane's rules (1 is first). Omit to leave it where it is.

Response

The tool's result.

idstring required

Changes

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