boards.update

Rename a board or make it the active one

Request: PATCH/api/v1/boards/{boardId}
Scope required: boards:write
Effect: Changes data. Send an Idempotency-Key if you might retry it.
Acts on: Acts on the account’s own job search.
MCP tool: boards_update
Environment: Live and sandbox alike.
Request body: JSON.

What it does

Changes a board's name, its active flag, or both; a field you leave out is left alone. Activating a board deactivates whichever board was active before, and deactivating the only board an account has is refused with 422 because something has to be active. Send the `ETag` from a read as `If-Match` to be refused with 412 if the board changed in between. A board’s display settings are changed elsewhere, with `boards.update_settings`.

Parameters

Parameters this endpoint accepts, where each one goes, and whether it is required
Name	Sent in	Requirement	Accepts
boardId	path	Required	string
If-Match	header	Optional	string — The ETag of the version you read. The write is refused with 412 if the resource has changed since.

Request body

isActive: boolean, optional
name: string, optional

Response

applicationCount: integer, required
createdAt: string, required
id: string, required
isActive: boolean, required
name: string, required
updatedAt: string, required

Examples

Rename a board

Rename a board — request

curl -s -X PATCH https://www.jobapplicationtracking.com/api/v1/boards/brd_7 \
  -H "Authorization: Bearer $JAT_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Spring search"
}'

Rename a board — response

{
  "id": "brd_7",
  "name": "Spring search",
  "isActive": true,
  "applicationCount": 12,
  "createdAt": "2026-01-04T09:30:00.000Z",
  "updatedAt": "2026-02-11T17:05:00.000Z"
}