analytics

Change an annotation

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

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

Path parameters

projectIdstring required

The project the annotations belong to

annotationIdstring required

The annotation

Request body

reportIdstring nullable
startsOnstring required
endsOnstring nullable
textstring required
tagsstring[] required

Response

The annotation as stored

idstring required
reportIdstring nullable
startsOnstring required
endsOnstring required
textstring required
tagsstring[] required
createdByNamestring nullable
createdAtstring required
updatedAtstring required
canChangeboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.