Sign in

v2

latestSwagger 2.02026-07-26109144190.4 KB
Incidents
Notes

Create a new Note

Create a new note.

This API may be called a maximum of 2 times per second.

post/api-public/v1/incidents/{incidentNumber}/notes

Path parameters

incidentNumberinteger required

The incident number

Headers

X-VO-Api-Idstring required

Your API ID

X-VO-Api-Keystring required

Your API Key

Request body

namestring
display_namestring
json_valueobject

The note body

Response

Information about the note created

namestring

The unique name of your note

displayNamestring

The name that will typically be displayed when viewing each note. This plus the name field can often be used as a key/value pair themselves.

json_valueobject

A valid JSON object of arbitrary key value pairs. This is the k/v store of notes data you'll want to attach to an incident. Maximum size = 16 MB