Update dashboard
curl --request PUT \
--url https://app.alana.shopping/api/workspace/{workspaceId}/dashboards/{dashboardId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"widgets": [
{
"widget_type": "<string>",
"position": {
"x": 24,
"y": 1,
"w": 24,
"h": 24
},
"config": {},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
]
}
'import requests
url = "https://app.alana.shopping/api/workspace/{workspaceId}/dashboards/{dashboardId}"
payload = {
"name": "<string>",
"description": "<string>",
"widgets": [
{
"widget_type": "<string>",
"position": {
"x": 24,
"y": 1,
"w": 24,
"h": 24
},
"config": {},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
]
}
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({
name: '<string>',
description: '<string>',
widgets: [
{
widget_type: '<string>',
position: {x: 24, y: 1, w: 24, h: 24},
config: {},
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
}
]
})
};
fetch('https://app.alana.shopping/api/workspace/{workspaceId}/dashboards/{dashboardId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.alana.shopping/api/workspace/{workspaceId}/dashboards/{dashboardId}",
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([
'name' => '<string>',
'description' => '<string>',
'widgets' => [
[
'widget_type' => '<string>',
'position' => [
'x' => 24,
'y' => 1,
'w' => 24,
'h' => 24
],
'config' => [
],
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
]
]),
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 := "https://app.alana.shopping/api/workspace/{workspaceId}/dashboards/{dashboardId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"widgets\": [\n {\n \"widget_type\": \"<string>\",\n \"position\": {\n \"x\": 24,\n \"y\": 1,\n \"w\": 24,\n \"h\": 24\n },\n \"config\": {},\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\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("https://app.alana.shopping/api/workspace/{workspaceId}/dashboards/{dashboardId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"widgets\": [\n {\n \"widget_type\": \"<string>\",\n \"position\": {\n \"x\": 24,\n \"y\": 1,\n \"w\": 24,\n \"h\": 24\n },\n \"config\": {},\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.alana.shopping/api/workspace/{workspaceId}/dashboards/{dashboardId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"widgets\": [\n {\n \"widget_type\": \"<string>\",\n \"position\": {\n \"x\": 24,\n \"y\": 1,\n \"w\": 24,\n \"h\": 24\n },\n \"config\": {},\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"dashboard": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"brand_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"name": "<string>",
"layout": {
"version": 1,
"cols": 24,
"rowHeight": 136
},
"created_by": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"description": "<string>"
},
"widgets": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dashboard_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"widget_type": "<string>",
"position": {
"x": 24,
"y": 1,
"w": 24,
"h": 24
},
"config": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
]
}{
"error": "INVALID_REQUEST",
"details": {
"field": "email",
"message": "Invalid email format"
}
}{
"error": "UNAUTHORIZED",
"details": {
"message": "Missing or invalid authentication token"
}
}{
"error": "FORBIDDEN",
"details": {
"message": "User does not have permission to access this resource"
}
}{
"error": "NOT_FOUND",
"details": {
"message": "Resource not found"
}
}{
"error": "Too many requests"
}{
"error": "INTERNAL_SERVER_ERROR",
"details": {
"message": "An unexpected error occurred"
}
}Update Dashboard
Update dashboard metadata and (optionally) replace its widget set transactionally. Admin role required. When widgets is omitted, only the dashboard row is updated; when present, every widget on the dashboard is reconciled (insert/update/delete) in a single transaction.
PUT
/
api
/
workspace
/
{workspaceId}
/
dashboards
/
{dashboardId}
Update dashboard
curl --request PUT \
--url https://app.alana.shopping/api/workspace/{workspaceId}/dashboards/{dashboardId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"widgets": [
{
"widget_type": "<string>",
"position": {
"x": 24,
"y": 1,
"w": 24,
"h": 24
},
"config": {},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
]
}
'import requests
url = "https://app.alana.shopping/api/workspace/{workspaceId}/dashboards/{dashboardId}"
payload = {
"name": "<string>",
"description": "<string>",
"widgets": [
{
"widget_type": "<string>",
"position": {
"x": 24,
"y": 1,
"w": 24,
"h": 24
},
"config": {},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
]
}
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({
name: '<string>',
description: '<string>',
widgets: [
{
widget_type: '<string>',
position: {x: 24, y: 1, w: 24, h: 24},
config: {},
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
}
]
})
};
fetch('https://app.alana.shopping/api/workspace/{workspaceId}/dashboards/{dashboardId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.alana.shopping/api/workspace/{workspaceId}/dashboards/{dashboardId}",
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([
'name' => '<string>',
'description' => '<string>',
'widgets' => [
[
'widget_type' => '<string>',
'position' => [
'x' => 24,
'y' => 1,
'w' => 24,
'h' => 24
],
'config' => [
],
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
]
]),
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 := "https://app.alana.shopping/api/workspace/{workspaceId}/dashboards/{dashboardId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"widgets\": [\n {\n \"widget_type\": \"<string>\",\n \"position\": {\n \"x\": 24,\n \"y\": 1,\n \"w\": 24,\n \"h\": 24\n },\n \"config\": {},\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\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("https://app.alana.shopping/api/workspace/{workspaceId}/dashboards/{dashboardId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"widgets\": [\n {\n \"widget_type\": \"<string>\",\n \"position\": {\n \"x\": 24,\n \"y\": 1,\n \"w\": 24,\n \"h\": 24\n },\n \"config\": {},\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.alana.shopping/api/workspace/{workspaceId}/dashboards/{dashboardId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"widgets\": [\n {\n \"widget_type\": \"<string>\",\n \"position\": {\n \"x\": 24,\n \"y\": 1,\n \"w\": 24,\n \"h\": 24\n },\n \"config\": {},\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"dashboard": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"brand_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"name": "<string>",
"layout": {
"version": 1,
"cols": 24,
"rowHeight": 136
},
"created_by": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"description": "<string>"
},
"widgets": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dashboard_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"widget_type": "<string>",
"position": {
"x": 24,
"y": 1,
"w": 24,
"h": 24
},
"config": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
]
}{
"error": "INVALID_REQUEST",
"details": {
"field": "email",
"message": "Invalid email format"
}
}{
"error": "UNAUTHORIZED",
"details": {
"message": "Missing or invalid authentication token"
}
}{
"error": "FORBIDDEN",
"details": {
"message": "User does not have permission to access this resource"
}
}{
"error": "NOT_FOUND",
"details": {
"message": "Resource not found"
}
}{
"error": "Too many requests"
}{
"error": "INTERNAL_SERVER_ERROR",
"details": {
"message": "An unexpected error occurred"
}
}Authorizations
Bearer token authentication via Auth0. Users authenticate through Auth0 Universal Login. Include the access token in the Authorization header: Authorization: Bearer <token>
Headers
Path Parameters
The workspace ID
Pattern:
^ws_[a-z0-9]+$Query Parameters
Body
application/json
Required string length:
1 - 120Maximum string length:
2000Show child attributes
Show child attributes
When present, replaces the widget set for this dashboard transactionally. Widgets without id are created; widgets with an id matching an existing row are updated; widgets in the DB but absent from this array are deleted.
Show child attributes
Show child attributes
Last modified on April 25, 2026
⌘I