Change a board's settings
PATCH/api/v1/retro/boards/{boardID}/settings
Turns voting and comments on or off, and sorts every column's cards by votes (highest first) for everyone on the board. Fields left out are kept. The answer is all three settings as they now stand.
Requires the retro:board:write scope.
Authorization
Parameters
Path parameters
boardIDstring requiredThe board's ID.
Request body required
voting_enabledbooleancomments_enabledbooleansort_by_votesboolean
Responses
200
The board's settings.
successbooleandataBoardSettingsShow BoardSettings properties
voting_enabledbooleancomments_enabledbooleansort_by_votesboolean
400
The body is not JSON (INVALID_BODY).
successbooleanSent by Retro itself; refusals before the request reaches Retro (401, 429) carry onlyerror.errorobject requiredcodestring requiredmessagestring requiredrequest_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 the scope this endpoint needs (FORBIDDEN).
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/settings' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
"sort_by_votes": true,
"voting_enabled": false
}'
