AnnotationService

UpdateAnnotation

Updates an existing annotation using using the list of fields specified in update_mask.

patch/api/v1/annotations

Request

  • Base URL: https://api.siftstack.com
  • URL: https://api.siftstack.com/api/v1/annotations
  • Auth: HTTP bearer

Request body

updateMaskstring required

The list of fields to be updated. The fields available to be updated are name, description, start_time, end_time, assigned_to_user_id, state, tags, legend_config, linked_channels, metadata, and is_archived. Prefer the ArchiveAnnotation, UnarchiveAnnotation, and batch RPCs for changing archive state. Important Note: if tags is specified in the update mask and annotation.tags is an empty list then all associated tags on the annotation will be removed.

Response

A successful response.

Changes

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