Api session event editor set scheduled update: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
Tag: Manual revert
No edit summary
Line 1: Line 1:
API Event to Schedule a long-running update of all active overlays, indicators, panels and triggers.
API Event to Schedule a long-running update of all active [[Overlay]]s, [[Indicator]]s, [[Panel]]s and [[Trigger]]s.
{|class=wikitable
{|class=wikitable
!Name
!Name
Line 10: Line 10:
|OPTIONAL
|OPTIONAL
|(Integer number)
|(Integer number)
|Scheduled time in milliseconds since epoch 1970. Note: use 0 for direct execution or -1 to cancel
|Scheduled [[Time]] in milliseconds since epoch 1970. Note: use 0 for direct execution or -1 to cancel
|
|
|-
|-
Line 16: Line 16:
|OPTIONAL
|OPTIONAL
|(String)
|(String)
|Send Email to this address when finished (optional)
|Send Email to this [[Address]] when finished (optional)
|
|
|-
|-

Revision as of 14:09, 30 March 2026

API Event to Schedule a long-running update of all active Overlays, Indicators, Panels and Triggers.

Name Importance Type Description Values
0 OPTIONAL (Integer number) Scheduled Time in milliseconds since epoch 1970. Note: use 0 for direct execution or -1 to cancel
1 OPTIONAL (String) Send Email to this Address when finished (optional)
2 OPTIONAL (String) Send SMS to this number when finished (optional)

Response Codes

Response Code: Description
204 No Content
300-600 Codes Overview

Example POST

Example POST: https://engine.tygron.com/api/session/event/editor/set_scheduled_update/?f=HTML&token=API_TOKEN

with content:

[ 0, "", "" ]