Api session event editor overlay remove attribute: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 43: | Line 43: | ||
<syntaxhighlight lang="text" copy>var options = { | <syntaxhighlight lang="text" copy>var options = { | ||
method: "POST", | method: "POST", | ||
headers: { "Content-Type": "application/json", "Authorization": "Bearer | headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" }, | ||
body: '[ 1, "Attributes to remove 1" ]' | body: '[ 1, "Attributes to remove 1" ]' | ||
}; | }; | ||
Revision as of 06:54, 10 April 2026
API Event to Remove the specified attributes of the specified Overlay. The attributes, including attributes which are added to an Overlay by default, are removed entirely.
| 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"]) | Attributes to remove |
Response Codes
| Response Code: | Description |
|---|---|
| 204 | No Content |
| 300-600 | Codes Overview |
Example POST
Curl Example POST:
curl 'https://development.tygron.com/api/session/event/editoroverlay/remove_attribute/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, "Attributes to remove 1" ]'Curl Example multi item POST:
curl 'https://development.tygron.com/api/session/event/editoroverlay/remove_attribute/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ [ 1, 2, 3 ], [ "Attributes to remove 1", "Attributes to remove 2", "Attributes to remove 3" ] ]'JavaScript Example POST:
var options = {
method: "POST",
headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
body: '[ 1, "Attributes to remove 1" ]'
};
fetch("https://development.tygron.com/api/session/event/editoroverlay/remove_attribute/", options)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));