Api session event editor overlay set overlay image
API Event to Change the image displayed by a specified IMAGE Overlay. The image must be uploaded in the "Overlays" 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
Example POST: https://engine.tygron.com/api/session/event/editoroverlay/set_overlay_image/?f=HTML&token=API_TOKEN
with content:
[ [ 1, 2, 3 ], [ [ "A1", "B1" ], [ "A2", "B2" ], [ "A3", "B3" ] ] ]