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

Request

Base URL
https://api.victorops.com
Auth
none declared. Required headers: X-VO-Api-Id, X-VO-Api-Key
TypeScript
https://skmtc.dev/victorops/apis/victorops-api/docs/api-public/v1/incidents/:incidentNumber/notes/post.ts
A function with typed inputs. Its response is checked against the schema.

incidentNumberinteger required

The incident number

X-VO-Api-Idstring required

Your API ID

X-VO-Api-Keystring required

Your API Key

namestring

display_namestring

json_valueobject

The note body

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

No recorded changes to this operation across all 4 revisions of this API.