---
title: "Change an annotation"
method: PATCH
path: "/v1/projects/{projectId}/annotations/{annotationId}"
tags: ["analytics"]
---

# Change an annotation

`PATCH /v1/projects/{projectId}/annotations/{annotationId}`

## Request

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

Replaces an annotation's days, text, tags and where it shows. Open to its author and to holders of prodantix.annotations.write.

## Path parameters

- `projectId` string, required
- `annotationId` string, required

## Request body

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

## Response `200`

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)