Nurama Developers

update_board

Rename, redescribe, retier, archive, or reorder a board.

Mutating tool: it changes data in Nurama. Available only when the key carries the matching scope.

Rename, redescribe, retier, archive, or reorder a board. Pass only the fields that change. Pass description: null to clear it. When narrowing visibility would orphan tasks, set cascade: true to authorize the cleanup — without it the server returns 409 with errorData.blockers.

Input

PropertyTypeRequiredDescription
boardIdstringyesUUID of the board.
namestringnoNew name. min length 1
descriptionstring | nullnoNew description, or null to clear it.
visibility"creator" | "reviewer"[]noNew visibility tier set.
status"active" | "archived"noLifecycle status.
sortOrdernumbernoNew ordering position among project boards.
cascadebooleannoAuthorize automatic cleanup of dependents when narrowing visibility. Default false; the server 409s if cleanup would be required.

JSON Schema

{
  "type": "object",
  "properties": {
    "boardId": {
      "type": "string",
      "description": "UUID of the board."
    },
    "name": {
      "type": "string",
      "minLength": 1,
      "description": "New name."
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "description": "New description, or `null` to clear it."
    },
    "visibility": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "creator",
          "reviewer"
        ]
      },
      "description": "New visibility tier set."
    },
    "status": {
      "type": "string",
      "enum": [
        "active",
        "archived"
      ],
      "description": "Lifecycle status."
    },
    "sortOrder": {
      "type": "number",
      "description": "New ordering position among project boards."
    },
    "cascade": {
      "type": "boolean",
      "description": "Authorize automatic cleanup of dependents when narrowing visibility. Default false; the server 409s if cleanup would be required."
    }
  },
  "required": [
    "boardId"
  ],
  "additionalProperties": false
}

On this page