Sign in

v1

latestOpenAPI 3.0.3MIT2026-07-26104113247.1 KB
Create Annotations

Create Annotations

Create an Annotation. Requires a role of at least Analyst.

post/projects/{projectId}/annotations

Request body

datestring

A string representation of a date in "YYYY-MM-DD HH:mm:ss" format

descriptionstring

The text that will be shown when looking at the annotation

tagsnumber[]

The ids of the tags to be added to the annotation

Example request

{
  "date": "2022-02-15 12:00:00",
  "description": "Something interesting happened!"
}

Response

Success

statusstring required

The status of the response

Example response

{
  "status": "ok",
  "results": {
    "date": "2022-02-15 12:00:00",
    "description": "Something interesting happened!",
    "user": {
      "first_name": "John",
      "last_name": "Smith"
    }
  }
}