These docs are for v2023.08. Click to read the latest docs for v2023.12.

Patch

patch

https://api.formant.io/v1/admin/annotations/{id}

Update an annotation
Resource: annotations
Authorized roles: operator

Path Params

string

required

Body Params

PartialAnnotation

type

string

enum

editedAt

date-time | null

userId

uuid

annotationTemplateId

uuid | null

taggedUsers

string

publishedTo

string

note

string | null

uuid

createdAt

date-time

updatedAt

date-time

tags

object

organizationId

uuid

time

date-time

endTime

date-time | null

parentId

uuid

metadata

object

message

string

length ≤ 1024

viewed

boolean

deviceId

uuid | null

streamName

string | null

streamType

string | null

enum

eventTriggerId

uuid | null

notificationEnabled

boolean

Response

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200