Sign in

v1

latestOpenAPI 3.0.32026-07-24148824715.6 KB
Cases

Leave a note on an alert

Creates a note linked to a specific alert. You need the "Update alerts" permission to use this endpoint.

post/v2/cases/{case_identifier}/alerts/{alert_identifier}/notes

Path parameters

case_identifierstring uuid required

The unique identifier of the case.

alert_identifierstring uuid required

The unique identifier of the alert.

Request body

contentsstring required

The contents of the note to be created (up to 5000 characters).

Response

Created

alert_identifierstring uuid required

The identifier of the alert this note is linked to.

contentsstring required

The contents of the note.

created_atstring date-time required

The date and time at which this note was created.

created_bystring uuid required

The user identifier that created this note.

identifierstring uuid required

Unique identifier of the note.