Update a board
Changes a board's name, description, visibility, team and auto-archive setting.
Send name and description every time: name is required, and a
missing description is saved as empty. Leave out visibility to
keep it, and with it the board's team. When you send visibility: team, send the team_id too; moving a board into a team needs the
caller to be in that team.
auto_archive_days (1–365) is how long a card may sit in the done
list before it is archived; left out, it is not changed.
template and card_prefix are ignored here.
Requires the board:board:write scope.
Authorization
Parameters
Path parameters
boardIDstring requiredThe board's ID.
Request body required
namestring requireddescriptionstringSaved as empty when left out.visibilityVisibilityteam_idstringauto_archive_daysintegertemplatestringIgnored.card_prefixstringIgnored; a board's prefix never changes.
Responses
200
The board after the change.
dataobjectboardBoardShow Board properties
idstringnamestringdescriptionstringvisibilityVisibilityteam_idstringThe team ateamboard belongs to;""for every other board.card_prefixstringThe front of every card reference on the board, as inPLT-42. Never changes.created_bystringcreated_atstring (date-time)updated_atstring (date-time)auto_archive_daysintegerDays a card may sit in the done list before it is archived.0in the board list.
400
The body is not JSON for this endpoint (INVALID_BODY), or a field
breaks a rule (VALIDATION_ERROR): the name, description,
visibility and team rules of creating a board, or
auto_archive_days outside 1–365.
errorobject requiredcodestring requiredmessagestring requiredrequest_idstring
401
No API key was sent, or it is unknown, revoked or expired (UNAUTHORIZED).
errorobject requiredcodestring requiredmessagestring requiredrequest_idstring
403
The key lacks board:board:write, or the board is being moved into a team the caller is not in (FORBIDDEN).
errorobject requiredcodestring requiredmessagestring requiredrequest_idstring
404
It does not exist, or it is on a board the caller cannot see (NOT_FOUND).
errorobject requiredcodestring requiredmessagestring requiredrequest_idstring
429
Too many requests (RATE_LIMITED). Wait for Retry-After seconds.
Retry-AfterintegerSeconds to wait before retrying.
errorobject requiredcodestring requiredmessagestring requiredrequest_idstring
500
Something went wrong on EvoHub's side (INTERNAL_ERROR). Retry later.
errorobject requiredcodestring requiredmessagestring requiredrequest_idstring
Example request
curl -X PATCH 'https://evohub.io/api/v1/board/boards/brd_5b0c8e1a2f3d4c6b9a7e0d1f2c3b4a59' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
"name": "Platform",
"team_id": "team_8b2c4d6e-1f3a-4b5c-9d7e-0a1b2c3d4e5f",
"visibility": "team",
"description": "Infrastructure and platform work.",
"auto_archive_days": 90
}'
