Delete note

DELETE /api/v1/repos/notes

Remove a note from a commit.

DELETE /api/v1/repos/notes
Authorization: Bearer YOUR_JWT_TOKEN
Content-Type: application/json

{
  "sha": "abc123def456789...",
  "action": "remove",
  "author": {
    "name": "Cleanup Bot",
    "email": "[e-mail]"
  },
  "expected_ref_sha": "def789abc123..."
}

Request Body

Parameter	Type	Description
sha	Required	Commit SHA to remove the note from
action	Required	Set to "remove" to delete the note
author	Optional	Object with name and email for the notes commit
expected_ref_sha	Optional	Expected notes ref SHA for optimistic concurrency control

JWT Requirements

• The JWT must include the repository in the repo claim
• Requires git:write scope

Response

{
  "sha": "abc123def456789...",
  "target_ref": "refs/notes/commits",
  "base_commit": "previous123...",
  "new_ref_sha": "newref456...",
  "result": {
    "success": true,
    "status": "ok",
    "message": ""
  }
}

Response Fields

Field	Type	Description
sha	String	The commit SHA the note was attached to
target_ref	String	The notes reference (refs/notes/commits)
base_commit	Optional	Previous notes ref commit SHA
new_ref_sha	String	New notes ref SHA after the operation
result	Object	Operation result with success, status, and optional message

Error Responses

Status	Description
404 Not Found	Note doesn’t exist for the specified commit
409 Conflict	expected_ref_sha doesn’t match current notes ref
401 Unauthorized	Invalid JWT or missing git:write scope
400 Bad Request	Missing required fields