APIs & SDKs
Start typing to search…

Post

post https://api.formant.io/v1/admin/annotations

Create a new annotation.
Resource: annotations
Authorized roles: operator, device

Log in to see full request history
Body Params

Annotation

string
date-time | null

Internal use only, ignore.

string | null

User associated with this annotation.

string | null

If you want to create this annotation from an existing annotation template, enter its ID here.

string
string
string | null

Description of this annotation.

array of objects | null
focusedDataPoints
string
date-time
date-time
tags
object
string

ID of the organization in which to create this new event.

string | null

External ID of this event.

date-time
required

Start time of the data range relevant to this event.

date-time | null

End time of the data range relevant to this event.

string | null

If this custom event is related to another event, you can add the ID of that parent event here.

metadata
object

User-customizable metadata associated with this event in key-value pair format.

string
length ≤ 1024

Message of this event. Must match the message field in the Formant UI when configuring a custom event.

boolean
string | null

ID of the device relevant to this event.

string | null
string | null
string | null
boolean

Set this to true to enable notifications for this event.

object | null

Set this to temporarily mute notifications for this event.

date-time | null
Response

Updated 20 days ago

Did this page help you?
Language
Credentials
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 20 days ago

Did this page help you?