API Reference

Create a new alert

post
https://{endpoint}/v1/alerts

Create API allows us to create a new alert, whose status can be either active or schedueled.

Body Params

Create a new alert

string
required

The Alert message to be displayed on the pop up

string

Target link for the Alert

string
enum
required

Recipient group for this Alert

Allowed:
string

ID of the recipient

string
required

UTC Time from which this Alert should be displayed

string
required

UTC Time to which this Alert should be displayed

string
enum

Which group of members should this Alert be displayed to. Note: Applicable only if the recipient is set as Site

Allowed:
boolean
required

true: The Alert can be dismissed by users. false: The Alert cannot be dismissed by users.

string
enum
required

Status of alert.

Allowed:
Responses

Updated 5 days ago

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 days ago