Api session event editor overlay set overlay image
Jump to navigation
Jump to search
API Endpoint: editoroverlay/set_overlay_image.
Description: Change the image displayed by a specified IMAGE Overlay. The image must be uploaded in the "Overlay" directory.
| Name | Importance | Type | Description | Values |
|---|---|---|---|---|
| 0 | REQUIRED | (OVERLAY Integer ID or multiple values in array [1, 2, 3]) | Overlay IDs (must relate to an IMAGE Overlay) | |
| 1 | REQUIRED | (String or multiple values in array ["a", "b", "c"] or matrix [["a", "b"], ["c", "d"], ["e", "f"]]) | Array of Project asset names, omitting the directory |
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_overlay_image/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, [ "A1", "B1" ] ]'Curl example multi item POST:
curl 'https://engine.tygron.com/api/session/event/editoroverlay/set_overlay_image/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ [ 1, 2, 3 ], [ [ "A1", "B1" ], [ "A2", "B2" ], [ "A3", "B3" ] ] ]'JavaScript example POST:
var options = {
method: "POST",
headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
body: '[ 1, [ "A1", "B1" ] ]'
};
fetch("https://engine.tygron.com/api/session/event/editoroverlay/set_overlay_image/", options)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));