Skip to main content
POST
Create an annotation

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

Create an Annotation.

report_tokens
string[]
required

The tokens of the Reports to annotate.

date
string<date>
required

The date of the Annotation. ISO 8601 formatted.

message
string
required

The message of the Annotation.

title
string

The title of the Annotation. Defaults to a title generated from the first Report and date.

Response

Annotation created successfully.

Annotation model

token
string
required

The unique token identifying the Annotation.

title
string
required

The title of the Annotation.

report_tokens
string[]
required

The tokens of the Reports associated with the Annotation.

date
string | null
required

The date of the Annotation. ISO 8601 formatted.

Example:

"2026-08-12"

message
string | null
required

The message of the Annotation.