Skip to content

Edit a board

Rename a board or change its description.

On this page

Changes a board's own details. Changing what is on it starts with Add a board node, and who can reach it is Set board access settings: access_level is not editable here.

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

Who can edit a board

Editing follows the app exactly. You may edit a board if any of these is true:

  • you own it,
  • you hold Can manage everyone's generations and boards (MANAGE_ALL_GENERATIONS),
  • it is SHARED or RESTRICTED and you hold Can manage Shared assets (SHARE_ASSETS).

That last one is what lets a team curate shared boards without making everyone an owner. It does not extend to deleting: see Delete a board.

The same rule governs every write to a board's contents, so the node endpoints point back here rather than restating it.

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 to edit.Tq8vNc…

Send only what you are changing. At least one field is required, so an empty body is a 400 rather than a silent no-op.

Body

titlestringoptional
New board 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 \
  -H "Authorization: Bearer $RUNDIFFUSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"title": "Hero shots v2"}'

Response

200 OK with the full board, nodes and members included, so a client that renders the board can use the response directly instead of refetching. The fields are the ones Get a board documents.

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 edit it.
404BOARD_NOT_FOUND
No such board, or not one this credential can see.
429RATE_LIMITED
Too many requests. Board writes have a tighter budget than reads. See Rate limits.

View as Markdown