---
title: "Add an annotation"
method: POST
path: "/v1/projects/{projectId}/annotations"
tags: ["analytics"]
---

# Add an annotation

`POST /v1/projects/{projectId}/annotations`

## Request

- Base URL: `https://api.prodantix.com`
- URL: `https://api.prodantix.com/v1/projects/{projectId}/annotations`
- Auth: HTTP bearer

Marks a day, or a range when endsOn is given, with a note of up to 200 characters and one to ten tags. With reportId it shows on that report only; without, on every chart in the project whose dates cover it.

## Path parameters

- `projectId` string, required

## Request body

- object
  - `reportId` string, nullable
  - `startsOn` string, required
  - `endsOn` string, nullable
  - `text` string, required
  - `tags` string[], required

## Response `201`

The annotation as stored

- object
  - `id` string, required
  - `reportId` string, nullable
  - `startsOn` string, required
  - `endsOn` string, required
  - `text` string, required
  - `tags` string[], required
  - `createdByName` string, nullable
  - `createdAt` string, required
  - `updatedAt` string, required
  - `canChange` boolean, required

## Other responses

- `400`: The request does not describe an annotation
- `403`: The caller may not do this
- `404`: The project, report or annotation is not there

---

[API](https://skmtc.dev/prodantix/apis/prodantix-api.md) · [All operations](https://skmtc.dev/prodantix/apis/prodantix-api/llms.txt) · [OpenAPI document](https://skmtc.dev/prodantix/apis/prodantix-api/revisions/fde6615df5a1?raw)