Update the session sidebar layout
curl --request PUT \
--url http://localhost:8080/session-sidebar \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"card_order": [
"<string>"
],
"hidden_cards": [
"<string>"
]
}
'import requests
url = "http://localhost:8080/session-sidebar"
payload = {
"card_order": ["<string>"],
"hidden_cards": ["<string>"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({card_order: ['<string>'], hidden_cards: ['<string>']})
};
fetch('http://localhost:8080/session-sidebar', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/session-sidebar",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'card_order' => [
'<string>'
],
'hidden_cards' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:8080/session-sidebar"
payload := strings.NewReader("{\n \"card_order\": [\n \"<string>\"\n ],\n \"hidden_cards\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("http://localhost:8080/session-sidebar")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"card_order\": [\n \"<string>\"\n ],\n \"hidden_cards\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/session-sidebar")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"card_order\": [\n \"<string>\"\n ],\n \"hidden_cards\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"card_order": [
"<string>"
],
"hidden_cards": [
"<string>"
]
}{
"statusCode": 123,
"message": "<string>",
"error": "<string>"
}Session sidebar
Update
Reorder, hide or show cards and widgets in the session sidebar for the whole workspace.
PUT
/
session-sidebar
Update the session sidebar layout
curl --request PUT \
--url http://localhost:8080/session-sidebar \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"card_order": [
"<string>"
],
"hidden_cards": [
"<string>"
]
}
'import requests
url = "http://localhost:8080/session-sidebar"
payload = {
"card_order": ["<string>"],
"hidden_cards": ["<string>"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({card_order: ['<string>'], hidden_cards: ['<string>']})
};
fetch('http://localhost:8080/session-sidebar', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/session-sidebar",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'card_order' => [
'<string>'
],
'hidden_cards' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:8080/session-sidebar"
payload := strings.NewReader("{\n \"card_order\": [\n \"<string>\"\n ],\n \"hidden_cards\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("http://localhost:8080/session-sidebar")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"card_order\": [\n \"<string>\"\n ],\n \"hidden_cards\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/session-sidebar")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"card_order\": [\n \"<string>\"\n ],\n \"hidden_cards\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"card_order": [
"<string>"
],
"hidden_cards": [
"<string>"
]
}{
"statusCode": 123,
"message": "<string>",
"error": "<string>"
}The change applies to every agent.
card_order and hidden_cards replace the stored lists, so read them with Get layout first and send the full list you want. Entries must be unique. To put a widget between built-in cards, give its app:<mini app id> entry that place in card_order.
{ "card_order": ["session-tags", "app:<mini app id>", "contact"] }
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Was this page helpful?