Api session event editor area set name: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
API Endpoint to Set new name of existing [[Area]].
API Endpoint: editorarea/set_name.


API Endpoint name is Api session event editor area set name
API Endpoint name is Api session event editor area set name.
 
Use this endpoint to Set new name of existing [[Area]]


{|class=wikitable
{|class=wikitable
Line 34: Line 36:
|}
|}
===Example POST===
===Example POST===
Curl Example POST:
Curl example POST:


<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editorarea/set_name/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, "Area Name 1" ]'
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editorarea/set_name/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, "Area Name 1" ]'
</syntaxhighlight>
</syntaxhighlight>
Curl Example multi item POST:
Curl example multi item POST:


<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editorarea/set_name/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ [ 1, 2, 3 ], [ "Area Name 1", "Area Name 2", "Area Name 3" ] ]'
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editorarea/set_name/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ [ 1, 2, 3 ], [ "Area Name 1", "Area Name 2", "Area Name 3" ] ]'
</syntaxhighlight>
</syntaxhighlight>
JavaScript Example POST:
JavaScript example POST:


<syntaxhighlight lang="text" copy>var options = {
<syntaxhighlight lang="text" copy>var options = {
Line 55: Line 57:
</syntaxhighlight>
</syntaxhighlight>
{{article end|seealso=*[[Api session event editor area]]
{{article end|seealso=*[[Api session event editor area]]
*[[Api session items areas]]
}}
}}


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

Revision as of 11:22, 10 April 2026

API Endpoint: editorarea/set_name.

API Endpoint name is Api session event editor area set name.

Use this endpoint to Set new name of existing Area

Name Importance Type Description Values
0 REQUIRED (AREA Integer ID or multiple values in array [1, 2, 3]) Area
1 REQUIRED (String or multiple values in array ["a", "b", "c"]) Area Names

Response Codes

Response Code: Description
200 Boolean (Content was updated)
300-600 Codes Overview

Example POST

Curl example POST:

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

Curl example multi item POST:

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

JavaScript example POST:

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