v3

latestOpenAPI 3.0.12026-07-31240345599.7 KB

Alerts

Update alert note

This endpoint is used to update a note associated with a specific alert.

patch/api/{cloudId}/v1/alerts/{alertId}/notes/{id}

Path parameters

alertIdstring required

Identifier of the alert.

idstring required

Identifier of the note.

Request body

notestring required

Example request

{
  "note": "System downtime expected due to maintenance activities."
}

Response

Returned if the request is successful.

idstring

Identifier of the note.

createdAtstring date-time

Represents the timestamp at which the alert note was added.

updatedAtstring date-time

Represents the timestamp at which the alert note was updated.

notestring

Represents the actual note.

ownerstring

Signifies the entity that added the note.

Example response

{
  "id": "1704869443312000050",
  "createdAt": "2024-01-05T07:06:47.958Z",
  "updatedAt": "2024-01-05T07:06:47.958Z",
  "note": "System downtime expected due to maintenance activities.",
  "owner": "user@atlassian.com"
}