Skip to content

Edit a board node

Rename a board node or change its description.

On this page

Changes a node's own details. A node's name belongs to the board, not to the tool, so editing one here changes nothing about the tool or about any other board. That is what makes a board holding the same tool twice readable.

PATCHhttps://api2.rundiffusion.com/api/v2/boards/{board_id}/nodes/{node_id}
AcceptsOAuth device flowPersonal API Access TokenCompany API Access Token

Editing a node needs edit access to the board, described under Who can edit a board.

Request

Headers

AuthorizationstringRequired
Bearer token. This endpoint accepts an OAuth device flow token, a Personal API Access Token, or a Company API Access Token. See Authentication.Authorization: Bearer eyJhbGciOi…

Path parameters

board_idstringRequired
The board the node is on.Tq8vNc…
node_idstringRequired
The node to rename, from Get a board.Nd4kWs…

Send at least one field.

Body

titlestringoptional
New node name, up to 100 characters. Cannot be blank when sent.
descriptionstring | nulloptional
New description, up to 1000 characters. Send null or an empty string to clear it.
curl -X PATCH https://api2.rundiffusion.com/api/v2/boards/$BOARD_ID/nodes/$NODE_ID \
  -H "Authorization: Bearer $RUNDIFFUSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"title": "Draft pass"}'

Response

200 OK with the updated Node object. Renaming never moves it, so position.list_view_index is unchanged. Moving a node is Reorder board nodes.

Errors

Status codes

400INVALID_REQUEST
A blank title, a field over its length limit, or a request with nothing in it.
401TOKEN_INVALID
Missing or invalid credential.
403PERMISSION_DENIED
You can see the board but may not change what is on it.
404BOARD_NOT_FOUND
No such board, or not one this credential can see.
404NODE_NOT_FOUND
No such node on that board, or it was already removed.
429RATE_LIMITED
Too many requests. Board writes have a tighter budget than reads. See Rate limits.

View as Markdown