Annotations

Create annotation

Adds a note at a point in time or across a range. Requires site.manage_annotations.

post/api/sites/{id}/annotations

Request

  • Base URL: https://demo.hitkeep.com
  • URL: https://demo.hitkeep.com/api/sites/{id}/annotations
  • Auth: one of:
    • API key in cookie hk_token
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

idstring uuid required

Request body

bodystring required
ends_atstring date-time

Set to mark a range; must not be before starts_at.

starts_atstring date-time required

Response

Created annotation

bodystring
created_atstring date-time
ends_atstring date-time

Omitted for a single point in time.

idstring uuid
site_idstring uuid
starts_atstring date-time

Changes

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