Skip to content

Issue Tracker - Notes

POST   /api/issue-tracker-notes
PUT    /api/issue-tracker-notes/{id}
DELETE /api/issue-tracker-notes/{id}

Required privilege: Issue Tracker / Edit

Notes are comments attached to issue tracker tickets. Use them to document progress, communicate updates, or record decisions.


Note Object

{
  "id": "NOTE-001",
  "Ticket Id": "TKT-001",
  "Content": "Contacted supplier - new ETA confirmed for March 20.",
  "Author Email": "jane.doe@acme.com",
  "Created At": "2024-03-11T10:30:00Z",
  "Updated At": "2024-03-11T10:30:00Z"
}

POST - Add Note

POST /api/issue-tracker-notes HTTP/1.1
Content-Type: application/json
X-XSRF-TOKEN: <csrf>

{
  "Ticket Id": "TKT-001",
  "Content": "Contacted supplier - new ETA confirmed for March 20."
}
Field Type Required Description
Ticket Id string Yes Ticket to attach the note to
Content string Yes Note text

Response

{
  "message": "Note added.",
  "id": "NOTE-002"
}

PUT - Update Note

PUT /api/issue-tracker-notes/NOTE-001 HTTP/1.1
Content-Type: application/json
X-XSRF-TOKEN: <csrf>

{
  "Content": "Updated: ETA now March 22 - supplier revised."
}

DELETE - Delete Note

DELETE /api/issue-tracker-notes/NOTE-001 HTTP/1.1
X-XSRF-TOKEN: <csrf>