---
title: "Create an annotation"
method: POST
path: "/user/v1alpha1/annotation"
tags: ["annotations"]
deprecated: true
---

# Create an annotation

`POST /user/v1alpha1/annotation`

## Request

- Base URL: `https://api.fulcradynamics.com`
- URL: `https://api.fulcradynamics.com/user/v1alpha1/annotation`
- Auth: HTTP bearer

> **Deprecated.**

Create a new annotation

## Query parameters

- `response_class` unknown

## Request body

- union
  - BooleanAnnotation: Represents an annotation with a yes or no measurement
    - `annotation_type` 'boolean'
    - `description` string, required: Description
    - `measurement_spec` BooleanMeasurement, required: Represents a yes or no measurement configuration
      - `boolean` BooleanMeasurementSpec, required
        - `value` boolean, nullable: Default value
      - `measurement_type` 'boolean'
      - `metric_kind` 'cumulative' | 'discrete'
      - `unit` unknown
      - `value_type` 'boolean'
    - `name` string, required: Name
    - `spec` AnnotationSpecContainer
      - `default_note` string, nullable: Default note text, if any
    - `tags` string[], required: Default tags
  - DurationAnnotation: Represents an annotation with a time interval measurement
    - `annotation_type` 'duration'
    - `description` string, required: Description
    - `measurement_spec` DurationMeasurement, required: Represents a time duration measurement configuration
      - `measurement_type` 'duration'
      - `metric_kind` 'cumulative' | 'discrete'
      - `unit` unknown
      - `value_type` 'duration'
    - `name` string, required: Name
    - `spec` AnnotationSpecContainer
      - `default_note` string, nullable: Default note text, if any
    - `tags` string[], required: Default tags
  - MomentAnnotation: Represents an annotation with no measurement
    - `annotation_type` 'moment'
    - `description` string, required: Description
    - `measurement_spec` unknown
    - `name` string, required: Name
    - `spec` AnnotationSpecContainer
      - `default_note` string, nullable: Default note text, if any
    - `tags` string[], required: Default tags
  - NumericAnnotation: Represents an annotation with a quantitative property measurement
    - `annotation_type` 'numeric'
    - `description` string, required: Description
    - `measurement_spec` union, required
      - CountMeasurement: Represents a count measurement configuration
        - `count` CountMeasurementSpec, required
          - `value` number, nullable: Default value
        - `measurement_type` 'count'
        - `metric_kind` 'cumulative' | 'discrete'
        - `unit` unknown
        - `value_type` 'real'
      - CustomMeasurement: Represents a custom non-convertable measurement configuration
        - `custom` CustomMeasurementSpec, required
          - `value` number, nullable: Default value
        - `measurement_type` 'custom'
        - `metric_kind` 'cumulative' | 'discrete'
        - `unit` string, nullable
        - `value_type` 'real'
      - DistanceMeasurement: Represents a distance or length measurement configuration
        - `distance` DistanceMeasurementSpec, required
          - `value` number, nullable: Default value
        - `measurement_type` 'distance'
        - `metric_kind` 'cumulative' | 'discrete'
        - `unit` 'inch' | 'foot' | 'yard' | 'mile' | 'millimeter' | 'centimeter' | 'meter' | 'kilometer'
        - `value_type` 'real'
      - MassMeasurement: Represents a mass measurement configuration and may be inferred from weight
        - `mass` MassMeasurementSpec, required
          - `value` number, nullable: Default value
        - `measurement_type` 'mass'
        - `metric_kind` 'cumulative' | 'discrete'
        - `unit` 'ounce' | 'pound' | 'microgram' | 'milligram' | 'gram' | 'kilogram' | 'stone'
        - `value_type` 'real'
      - PercentMeasurement: Represents a percentage measurement configuration
        - `measurement_type` 'percent'
        - `metric_kind` 'cumulative' | 'discrete'
        - `percent` PercentMeasurementSpec, required
          - `value` number, nullable: Default value
        - `unit` 'percent'
        - `value_type` 'real'
      - PeriodMeasurement: Represents a time period measurement configuration
        - `measurement_type` 'period'
        - `metric_kind` 'cumulative' | 'discrete'
        - `period` PeriodMeasurementSpec, required
          - `value` number, nullable: Default value
        - `unit` 'second'
        - `value_type` 'real'
      - TemperatureMeasurement: Represents a temperature measurement configuration
        - `measurement_type` 'temperature'
        - `metric_kind` 'cumulative' | 'discrete'
        - `temperature` TemperatureMeasurementSpec, required
          - `value` number, nullable: Default value
        - `unit` 'degree_celsius' | 'degree_fahrenheit'
        - `value_type` 'real'
      - VolumeMeasurement: Represents a physical volume measurement configuration
        - `measurement_type` 'volume'
        - `metric_kind` 'cumulative' | 'discrete'
        - `unit` 'teaspoon' | 'tablespoon' | 'fluid_ounce' | 'pint' | 'quart' | 'gallon' | 'millileter' | 'liter'
        - `value_type` 'real'
        - `volume` VolumeMeasurementSpec, required
          - `value` number, nullable: Default value
    - `name` string, required: Name
    - `spec` AnnotationSpecContainer
      - `default_note` string, nullable: Default note text, if any
    - `tags` string[], required: Default tags
  - PeopleAnnotation: Represents an annotation recording contact with other people
    - `annotation_type` 'people'
    - `description` string, required: Description
    - `measurement_spec` unknown
    - `name` string, required: Name
    - `spec` unknown
    - `tags` string[], required: Default tags
  - ScaleAnnotation: Represents an annotation with a fixed scale measurement and customizable display
    - `annotation_type` 'scale'
    - `description` string, required: Description
    - `measurement_spec` ScaleMeasurement, required: Represents a discrete scale measurement configuration with minimum and maximum values
      - `measurement_type` 'scale'
      - `metric_kind` 'cumulative' | 'discrete'
      - `scale` ScaleMeasurementSpec, required
        - `max_allowed` integer, required: Maxiumum value on scale
        - `min_allowed` integer, required: Minimum value on scale
        - `value` integer, nullable: Default value
      - `unit` unknown
      - `value_type` 'integer'
    - `name` string, required: Name
    - `spec` ScaleAnnotationSpecContainerInput, required
      - `default_note` string, nullable: Default note text, if any
      - `scale` ScaleAnnotationSpecInput, required
        - `label_mapping` StringScaleMapping, required: Represents a scale mapping to strings or emojis
          - `mapping_type` 'string'
          - `string` StringScaleMappingSpec, required
            - `mapping` object, required: Mapping of scale values to strings
        - `scale_mapping` union: Display value mappoing for each scale value
          - ColorScaleMappingInput: Represents a scale mapping to colorrs
            - `color` ColorScaleMappingSpecInput, required
              - …
            - `mapping_type` 'color'
          - EmojiScaleMappingInput: Represents a scale mapping to colorrs
            - `color` ColorScaleMappingSpecInput, required
              - …
            - `mapping_type` 'emoji'
            - `string` StringScaleMappingSpec, required
              - …
    - `tags` string[], required: Default tags

## Response `200`

Successful Response

- unknown

## Other responses

- `422`: Validation Error

---

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