Api session event editor chat set instructions: Difference between revisions
Jump to navigation
Jump to search
Created page with "API Endpoint: api/session/event/editorchat/set_instructions/ Description: Set Instructions {|class=wikitable !Index !Importance !Type !Description !Values |- | 0 | REQUIRED | (CHAT_CHANNEL Integer ID or multiple integer values in array [1, 2, 3]) | Chat Channels | |- | 1 | REQUIRED | (String or multiple values in array ["a", "b", "c"]) | String[] | |} ===Response Codes=== {|class=wikitable !Response Code: !Description |- | 200 | Boolean (Content was updated) |- |..." |
No edit summary |
||
| Line 1: | Line 1: | ||
API Endpoint: api/session/event/editorchat/set_instructions/ | API Endpoint: api/session/event/editorchat/set_instructions/ | ||
Description: Set | Description: Set the instructions of a [[Chat Channel]]. | ||
{|class=wikitable | {|class=wikitable | ||
| Line 19: | Line 19: | ||
| REQUIRED | | REQUIRED | ||
| (String or multiple values in array ["a", "b", "c"]) | | (String or multiple values in array ["a", "b", "c"]) | ||
| | | Instructions | ||
| | | | ||
|} | |} | ||
| Line 35: | Line 35: | ||
===Example POST=== | ===Example POST=== | ||
Curl example POST | Curl example POST | ||
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editorchat/set_instructions/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, " | <syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editorchat/set_instructions/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, "Instruction 1" ]' | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Curl example multi item POST | Curl example multi item POST | ||
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editorchat/set_instructions/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ [ 1, 2, 3 ], [ " | <syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editorchat/set_instructions/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ [ 1, 2, 3 ], [ "Instruction 1", "Instruction 2", "Instruction 3" ] ]' | ||
</syntaxhighlight> | </syntaxhighlight> | ||
JavaScript example POST | JavaScript example POST | ||
| Line 44: | Line 44: | ||
method: "POST", | method: "POST", | ||
headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" }, | headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" }, | ||
body: '[ 1, " | body: '[ 1, "Instruction 1" ]' | ||
}; | }; | ||
fetch("https://engine.tygron.com/api/session/event/editorchat/set_instructions/", options) | fetch("https://engine.tygron.com/api/session/event/editorchat/set_instructions/", options) | ||
Revision as of 15:29, 10 November 2026
API Endpoint: api/session/event/editorchat/set_instructions/
Description: Set the instructions of a Chat Channel.
| Index | Importance | Type | Description | Values |
|---|---|---|---|---|
| 0 | REQUIRED | (CHAT_CHANNEL Integer ID or multiple integer values in array [1, 2, 3]) | Chat Channels | |
| 1 | REQUIRED | (String or multiple values in array ["a", "b", "c"]) | Instructions |
Response Codes
| Response Code: | Description |
|---|---|
| 200 | Boolean (Content was updated) |
| 300-600 | Codes Overview |
Example POST
Curl example POST
curl 'https://engine.tygron.com/api/session/event/editorchat/set_instructions/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, "Instruction 1" ]'Curl example multi item POST
curl 'https://engine.tygron.com/api/session/event/editorchat/set_instructions/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ [ 1, 2, 3 ], [ "Instruction 1", "Instruction 2", "Instruction 3" ] ]'JavaScript example POST
var options = {
method: "POST",
headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
body: '[ 1, "Instruction 1" ]'
};
fetch("https://engine.tygron.com/api/session/event/editorchat/set_instructions/", options)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));