Api session event editor overlay remove: Difference between revisions
Jump to navigation
Jump to search
Created page with "API Event to Remove the specified Overlays. {|class=wikitable !Name !Importance !Type !Description !Values |- |0 |REQUIRED |(OVERLAY Integer ID or multiple values in array [1, 2, 3]) |Overlay IDs | |} ===Response Codes=== {|class=wikitable !Response Code: !Description |- |200 |Boolean (True when at least one item was removed) |- |300-600 |Codes Overview |} ===Example POST=== Example POST: https://engine.tygron.com/api/session/event/editoroverlay/remove/?f=HTML&to..." |
No edit summary |
||
| (11 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
API | API Endpoint: api/session/event/editoroverlay/remove/ | ||
Description: Remove the specified [[Overlay]]. | |||
{|class=wikitable | {|class=wikitable | ||
!Name | !Name | ||
| Line 25: | Line 28: | ||
|} | |} | ||
===Example POST=== | ===Example POST=== | ||
Curl example POST: | |||
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editoroverlay/remove/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '1' | |||
</syntaxhighlight> | |||
Curl example multi item POST: | |||
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editoroverlay/remove/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, 2, 3 ]' | |||
</syntaxhighlight> | |||
JavaScript example POST: | |||
<syntaxhighlight lang="text" copy>var options = { | |||
method: "POST", | |||
</ | headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" }, | ||
{{article end|seealso=*[[ | body: '1' | ||
}; | |||
fetch("https://engine.tygron.com/api/session/event/editoroverlay/remove/", 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]] | |||
*[[Api session items overlays]] | |||
}} | |||
[[Category:API]] | [[Category:API]] | ||
Latest revision as of 08:16, 15 May 2026
API Endpoint: api/session/event/editoroverlay/remove/
Description: Remove the specified Overlay.
| Name | Importance | Type | Description | Values |
|---|---|---|---|---|
| 0 | REQUIRED | (OVERLAY Integer ID or multiple values in array [1, 2, 3]) | Overlay IDs |
Response Codes
| Response Code: | Description |
|---|---|
| 200 | Boolean (True when at least one item was removed) |
| 300-600 | Codes Overview |
Example POST
Curl example POST:
curl 'https://engine.tygron.com/api/session/event/editoroverlay/remove/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '1'Curl example multi item POST:
curl 'https://engine.tygron.com/api/session/event/editoroverlay/remove/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, 2, 3 ]'JavaScript example POST:
var options = {
method: "POST",
headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
body: '1'
};
fetch("https://engine.tygron.com/api/session/event/editoroverlay/remove/", options)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));