StatusDashboard
EventsNotes

Update note

Edit the text of an existing internal note.

View Markdown

PUT /app/events/{id}/notes/{noteId}

Replaces the note text. The note is marked as isEdited: true. Uses PUT (full replace of the note field) — see Documented PUT exceptions in API Basics.


Path parameters

ParameterDescription
idThe event ID.
noteIdThe note ID.

Request

See API Basics for required headers.

Request body

FieldTypeRequiredDescription
notestringYesUpdated note text. Max 5,000 characters.

Sample request

curl -X PUT https://api.statusdashboard.com/app/events/4f8b2e1a-3c7d-4e9f-a0b1-c2d3e4f56789/notes/2e8c5b9a-4d7f-4a0b-b2d4-e5f6789abcde \
  -H "Authorization: Bearer bcf847abf5c6:def456" \
  -H "Content-Type: application/json" \
  -d '{
    "note": "Escalated to database team at 10:15 UTC. Pager duty alert sent. DBA responded at 10:22 UTC."
  }'

Sample response

Status: 200 OK

{
  "note": {
    "noteId": "2e8c5b9a-4d7f-4a0b-b2d4-e5f6789abcde",
    "timestamp": "2026-04-25T10:15:00.000Z",
    "note": "Escalated to database team at 10:15 UTC. Pager duty alert sent. DBA responded at 10:22 UTC.",
    "author": "user@example.com",
    "isEdited": true
  }
}

Error responses

StatusWhen
400Validation error — note text missing or too long.
403Insufficient permissions.
404Event or note not found.

On this page

We use cookies

We use essential cookies to keep the site working, and optional analytics cookies to understand how it's used. Read our Privacy Policy.