Api session event editor overlay set name: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
← Older edit
Maxim@tygron.com (talk | contribs)
Tygron, Tygron_admin, Bureaucrats, Administrators
4,404 edits
No edit summary
Maxim@tygron.com (talk | contribs)
Tygron, Tygron_admin, Bureaucrats, Administrators
4,404 edits
No edit summary
 
(5 intermediate revisions by one other user not shown)
Line 1: Line 1:
API Event to Set the name for a specified [[Overlay]].
API Endpoint: editoroverlay/set_name.
 
Description: Set the name for a specified [[Overlay]].
 
{|class=wikitable
{|class=wikitable
!Name
!Name
Line 31: Line 34:
|}
|}
===Example POST===
===Example POST===
Example POST: https://engine.tygron.com/api/session/event/editoroverlay/set_name/?f=JSON&token=API_TOKEN
Curl example POST:
 
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editoroverlay/set_name/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, "Name for the Overlay 1" ]'
</syntaxhighlight>
Curl example multi item POST:
 
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editoroverlay/set_name/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ [ 1, 2, 3 ], [ "Name for the Overlay 1", "Name for the Overlay 2", "Name for the Overlay 3" ] ]'
</syntaxhighlight>
JavaScript example POST:


with content:
<syntaxhighlight lang="text" copy>var options = {
<pre>[ [ 1, 2, 3 ], [ "Name for the Overlay 1", "Name for the Overlay 2", "Name for the Overlay 3" ] ]
 method: "POST",
</pre>
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 body: '[ 1, "Name for the Overlay 1" ]'
};
fetch("https://engine.tygron.com/api/session/event/editoroverlay/set_name/", options)
 .then(response => response.text())
 .then(result => console.log(result))
 .catch(error => console.log('error', error));
</syntaxhighlight>
{{article end|seealso=*[[Api session event editor overlay]]
{{article end|seealso=*[[Api session event editor overlay]]
*[[Api session items overlays]]
*[[Api session items overlays]]

Latest revision as of 13:01, 13 April 2026

API Endpoint: editoroverlay/set_name.

Description: 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

Curl example POST: 

curl 'https://engine.tygron.com/api/session/event/editoroverlay/set_name/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, "Name for the Overlay 1" ]'

Curl example multi item POST: 

curl 'https://engine.tygron.com/api/session/event/editoroverlay/set_name/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ [ 1, 2, 3 ], [ "Name for the Overlay 1", "Name for the Overlay 2", "Name for the Overlay 3" ] ]'

JavaScript example POST: 

var options = {
 method: "POST",
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 body: '[ 1, "Name for the Overlay 1" ]'
};
fetch("https://engine.tygron.com/api/session/event/editoroverlay/set_name/", options)
 .then(response => response.text())
 .then(result => console.log(result))
 .catch(error => console.log('error', error));

See also

Retrieved from "https://support.tygron.com/w/index.php?title=Api_session_event_editor_overlay_set_name&oldid=75793"