Skip to main content
PUT
Update an annotation

Authorizations

Authorization
string
header
required

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

Path Parameters

annotation_token
string
required

The token of the Annotation.

Body

application/json

Update an Annotation.

title
string

The title of the Annotation.

date
string<date>

The date of the Annotation. ISO 8601 formatted.

message
string

The message of the Annotation.

report_tokens
string[]

The tokens of the Reports to associate with the Annotation.

Response

Annotation updated 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.