Rename or move a board
Changes a board's name and description, and optionally its team and visibility. Works on a closed board too.
nameis required on every call, at most 200 characters.descriptionis replaced by what you send; leaving it out clears it.team_id: left out, the board stays where it is;""moves it to the whole organization; a team must be one the caller is in.visibility: left out, it is kept. Ateamboard needs a team.
Requires the retro:board:write scope.
Authorization
Parameters
Path parameters
boardIDstring requiredThe board's ID.
Request body required
namestring requireddescriptionstringReplaces the description; left out, it is cleared.team_idstringLeft out keeps the board's team;""moves it to the whole organization.visibilityVisibility
Responses
200
The board was changed.
successbooleandataobjectidstring
400
The body is not JSON (INVALID_BODY), name is missing or blank
(MISSING_NAME), name is over 200 characters
(VALIDATION_FAILED), visibility is unknown
(INVALID_VISIBILITY), or a team board would have no team
(TEAM_REQUIRED).
- Error
Show Error properties
successbooleanSent by Retro itself; refusals before the request reaches Retro (401, 429) carry onlyerror.errorobject requiredcodestring requiredmessagestring requiredrequest_idstring
- ValidationFailed
Show ValidationFailed properties
successbooleanerrorobject requiredcodestring requiredmessagestring requireddetailsarray of object requiredfieldstringmessagestring
request_idstring
401
No API key was sent, or it is unknown, revoked or expired (UNAUTHORIZED).
successbooleanSent by Retro itself; refusals before the request reaches Retro (401, 429) carry onlyerror.errorobject requiredcodestring requiredmessagestring requiredrequest_idstring
403
The key lacks retro:board:write (FORBIDDEN), or team_id names a team the caller is not in (NOT_IN_TEAM).
successbooleanSent by Retro itself; refusals before the request reaches Retro (401, 429) carry onlyerror.errorobject requiredcodestring requiredmessagestring requiredrequest_idstring
404
The board does not exist, or the caller cannot see it (NOT_FOUND).
successbooleanSent by Retro itself; refusals before the request reaches Retro (401, 429) carry onlyerror.errorobject requiredcodestring requiredmessagestring requiredrequest_idstring
429
Too many requests (RATE_LIMITED). Wait for Retry-After seconds.
Retry-AfterintegerSeconds to wait before retrying.
successbooleanSent by Retro itself; refusals before the request reaches Retro (401, 429) carry onlyerror.errorobject requiredcodestring requiredmessagestring requiredrequest_idstring
500
Something went wrong on EvoHub's side (INTERNAL_ERROR). Retry later.
successbooleanSent by Retro itself; refusals before the request reaches Retro (401, 429) carry onlyerror.errorobject requiredcodestring requiredmessagestring requiredrequest_idstring
Example request
curl -X PATCH 'https://evohub.io/api/v1/retro/boards/brd_3f9a1c7e2b8d4a60' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
"name": "Sprint 42 retrospective",
"description": "What went well and what to change after sprint 42"
}'
