Api session event editor overlay set name: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
Created page with "API Event to Set the name for a specified Overlay. {|class=wikitable !Name !Importance !Type !Description !Values |- |0 |REQUIRED |(OVERLAY Integer ID or multiple values in array [1, 2, 3]) |Overlay ID | |- |1 |REQUIRED |(String or multiple values in array ["a", "b", "c"]) |Name for the Overlay | |} ===Response Codes=== {|class=wikitable !Response Code: !Description |- |204 |No Content |- |300-600 |Codes Overview |} ===Example POST=== Example POST: https://en..."
 
No edit summary
 
(3 intermediate revisions by the same user not shown)
Line 31: Line 31:
|}
|}
===Example POST===
===Example POST===
Example POST: https://engine.tygron.com/api/session/event/editoroverlay/set_name/?f=HTML&token=API_TOKEN
Example POST: https://engine.tygron.com/api/session/event/editoroverlay/set_name/?f=JSON&token=API_TOKEN


with content:  
with content:  
<pre>[ [ 1, 2, 3 ], [ "Name for the Overlay 1", "Name for the Overlay 2", "Name for the Overlay 3" ] ]
<pre>[ [ 1, 2, 3 ], [ "Name for the Overlay 1", "Name for the Overlay 2", "Name for the Overlay 3" ] ]
</pre>
</pre>
{{article end|seealso=*[[api session event editor overlay]]}}
{{article end|seealso=*[[Api session event editor overlay]]
*[[Api session items overlays]]
}}


[[Category:API]]
[[Category:API]]

Latest revision as of 12:12, 1 April 2026

API Event to Set the name for a specified Overlay.

Name Importance Type Description Values
0 REQUIRED (OVERLAY Integer ID or multiple values in array [1, 2, 3]) Overlay ID
1 REQUIRED (String or multiple values in array ["a", "b", "c"]) Name for the Overlay

Response Codes

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

Example POST

Example POST: https://engine.tygron.com/api/session/event/editoroverlay/set_name/?f=JSON&token=API_TOKEN

with content:

[ [ 1, 2, 3 ], [ "Name for the Overlay 1", "Name for the Overlay 2", "Name for the Overlay 3" ] ]