Api session event editor overlay set name: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 10: | Line 10: | ||
!Values | !Values | ||
|- | |- | ||
|0 | | 0 | ||
|REQUIRED | | REQUIRED | ||
|(OVERLAY Integer ID or multiple values in array [1, 2, 3]) | | (OVERLAY Integer ID or multiple values in array [1, 2, 3]) | ||
|[[Overlay]] ID | | [[Overlay]] ID | ||
| | | | ||
|- | |- | ||
|1 | | 1 | ||
|REQUIRED | | REQUIRED | ||
|(String or multiple values in array ["a", "b", "c"]) | | (String or multiple values in array ["a", "b", "c"]) | ||
|Name for the [[Overlay]] | | Name for the [[Overlay]] | ||
| | | | ||
|} | |} | ||
===Response Codes=== | ===Response Codes=== | ||
| Line 27: | Line 27: | ||
!Description | !Description | ||
|- | |- | ||
|204 | | 204 | ||
|No Content | | No Content | ||
|- | |- | ||
|300-600 | | 300-600 | ||
|Codes Overview | | Codes Overview | ||
|} | |} | ||
===Example POST=== | ===Example POST=== | ||
Revision as of 11:40, 8 June 2026
API Endpoint: api/session/event/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));