Api session event editor chat reset: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
Created page with "API Endpoint: api/session/event/editorchat/reset/ Description: Reset Chat Channel contents {|class=wikitable !Index !Importance !Type !Description !Values |- | 0 | REQUIRED | (CHAT_CHANNEL Integer ID or multiple integer values in array [1, 2, 3]) | Channel ID | |} ===Response Codes=== {|class=wikitable !Response Code: !Description |- | 200 | Boolean (Returns true if the channel was found and messages were removed, otherwise false.) |- | 300-600 | Codes Overview |}..."
 
No edit summary
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
API Endpoint: api/session/event/editorchat/reset/
API Endpoint: api/session/event/editorchat/reset/


Description: Reset [[Chat Channel]] contents
Description: Reset a [[Chat Channel]]'s content


{|class=wikitable
{|class=wikitable
Line 13: Line 13:
| REQUIRED
| REQUIRED
| (CHAT_CHANNEL Integer ID or multiple integer values in array [1, 2, 3])
| (CHAT_CHANNEL Integer ID or multiple integer values in array [1, 2, 3])
| Channel ID
| [[Chat Channel]]s
|  
|  
|}
|}
Line 22: Line 22:
|-
|-
| 200
| 200
| Boolean (Returns true if the channel was found and messages were removed, otherwise false.)
| Boolean (Returns true if the channel was found and messages were removed, otherwise false)
|-
|-
| 300-600
| 300-600

Latest revision as of 14:51, 11 November 2026

API Endpoint: api/session/event/editorchat/reset/

Description: Reset a Chat Channel's content

Index Importance Type Description Values
0 REQUIRED (CHAT_CHANNEL Integer ID or multiple integer values in array [1, 2, 3]) Chat Channels

Response Codes

Response Code: Description
200 Boolean (Returns true if the channel was found and messages were removed, otherwise false)
300-600 Codes Overview

Example POST

Curl example POST

curl 'https://engine.tygron.com/api/session/event/editorchat/reset/' -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/editorchat/reset/' -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/editorchat/reset/", options)
 .then(response => response.text())
 .then(result => console.log(result))
 .catch(error => console.log('error', error));