Create an Override

post

https://api.telemetrytv.com/overrides

Creates an Overrides

Body Params

type

string

enum

required

Pre defined overrides styles: 'alert' , info' or the name of an App , Board, or Media to display on your override

Allowed:

icon

string

available list of icons, which should be named by a pattern "fas||exclamation-triangle"

name

string

required

name of override

message

json

required

Takes the value to be used for displaying content on the override such as 'color', 'text' and 'icon'

color

string

color of the message example "#Fc5543"

text

string

text to be displayed in message

scheduling

object

"scheduling" parameter accepts one of "Manual", "Immediate", "Scheduled", "Reccuring"

day_recurrence

string

accepts "Weekdays", "Every Day", "Weekends", "First of the Month", "Specific Days".

days

array of strings

Defaults to empty

only specified if in day_reccurence parameter passed "specific days". Accepts "mon", "tue", "wed", "thu", "fri", "sat", "sun"

days

time_recurrence

string

accepts "Once per Day" , "Multiple Times per Day"

hour

string

Defaults to 12:00:00

period

string

Defaults to 120

parameters count in minutes

period_start

string

Defaults to empty

accepts time in format "08:00:00"

period_end

string

Defaults to empty

accepts time in format "08:00:00"

duration

string

Defaults to 60

accepts duration in seconds

desktop

boolean

Whether the type of override is desktop

organization_id

string

Defaults to empty

if override by organization id

device_tag

string

Defaults to empty

If override by device tag

device_id

string

Defaults to empty

if override by device id

Headers

content-type

string

required

Defaults to application/json

Responses

Language

Credentials

Header

Request

Response

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

application/json

201201

400400