1. Home
  2. Limnu API
  3. Function: boardRename

Function: boardRename

Overview

boardRename changes the name associated with an existing board.

Parameters

Input parameters:

  • apiKey: Private API key issued by Limnu to developers.
  • boardId: The boardId of the board you wish to rename, as issued by boardCreate.
  • boardName: The new name for the board. It does not need to be unique.

Example data

Example of correct JSON input:

{
"apiKey": "K_isR4E6qcQamY0NxFuKa9aw7k5hssRBQXuqpStgR1qU1A",
"boardId": "B_B7LyhbF2QGaCV4",
"boardName": "A renamed board"
}

Example of JSON output from a successful call:

{

"success": true

}

Example of JSON output from a failed call:

{

"success": false,

"reason": "No such board: B_B7LyhbF2QGaCV4"

}

Command Line Testing

Here’s an example of how to test boardRename from the command line:

curl \

https://api.limnu.com/v1/boardRename \

--request POST \

--header "Content-Type: application/json" \

--data @boardRename.json

 

The contents of the file named boardRename.json are:

{

"apiKey": "K_isR4E6qcQamY0NxFuKa9aw7k5hssRBQXuqpStgR1qU1A",

"boardId": "B_B7LyhbF2QGaCV4",

"boardName": "A renamed board"

}