Skip to main content

boards.delete

Delete a board and everything on it

Request
DELETE/api/v1/boards/{boardId}
Scope required
boards:write
Effect
Deletes something. Confirm with a person before calling it.
Acts on
Acts on the account’s own job search.
MCP tool
boards_delete
Environment
Live and sandbox alike.
Request body
JSON.

What it does

Deletes a board together with every application, interview and note that lived on it. This cannot be undone. Deleting the last board an account has is refused with 422; deleting the active board promotes the most recently created remaining board in its place. Answers 204 with no body. To empty a board rather than lose it, delete its cards one at a time with `applications.delete`.

Parameters

Parameters this endpoint accepts, where each one goes, and whether it is required
NameSent inRequirementAccepts
boardIdpathRequiredstring
If-MatchheaderOptionalstring — The ETag of the version you read. The write is refused with 412 if the resource has changed since.

Response

Answers 204 with no body.

Examples

Delete a finished search

Delete a finished search — request
curl -s -X DELETE https://www.jobapplicationtracking.com/api/v1/boards/brd_7 \
  -H "Authorization: Bearer $JAT_KEY"
Delete a finished search — response
null

Related operations