curl --request PUT \
--url https://app.formbricks.com/api/v3/dashboards/{dashboardId} \
--header 'Content-Type: application/json' \
--cookie next-auth.session-token= \
--data '
{
"name": "<string>",
"expectedUpdatedAt": "2023-11-07T05:31:56Z",
"widgets": [
{
"widgetId": "<string>",
"layout": {
"x": 5,
"y": 500,
"w": 6,
"h": 4
},
"order": 1073741823
}
],
"filters": [
{
"id": "<string>",
"field": "FeedbackRecords.sourceName",
"label": "<string>",
"values": [
"Website"
]
}
]
}
'import requests
url = "https://app.formbricks.com/api/v3/dashboards/{dashboardId}"
payload = {
"name": "<string>",
"expectedUpdatedAt": "2023-11-07T05:31:56Z",
"widgets": [
{
"widgetId": "<string>",
"layout": {
"x": 5,
"y": 500,
"w": 6,
"h": 4
},
"order": 1073741823
}
],
"filters": [
{
"id": "<string>",
"field": "FeedbackRecords.sourceName",
"label": "<string>",
"values": ["Website"]
}
]
}
headers = {
"cookie": "next-auth.session-token=",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {cookie: 'next-auth.session-token=', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
expectedUpdatedAt: '2023-11-07T05:31:56Z',
widgets: [{widgetId: '<string>', layout: {x: 5, y: 500, w: 6, h: 4}, order: 1073741823}],
filters: [
{
id: '<string>',
field: 'FeedbackRecords.sourceName',
label: '<string>',
values: ['Website']
}
]
})
};
fetch('https://app.formbricks.com/api/v3/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.formbricks.com/api/v3/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>',
'expectedUpdatedAt' => '2023-11-07T05:31:56Z',
'widgets' => [
[
'widgetId' => '<string>',
'layout' => [
'x' => 5,
'y' => 500,
'w' => 6,
'h' => 4
],
'order' => 1073741823
]
],
'filters' => [
[
'id' => '<string>',
'field' => 'FeedbackRecords.sourceName',
'label' => '<string>',
'values' => [
'Website'
]
]
]
]),
CURLOPT_COOKIE => "next-auth.session-token=",
CURLOPT_HTTPHEADER => [
"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.formbricks.com/api/v3/dashboards/{dashboardId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"expectedUpdatedAt\": \"2023-11-07T05:31:56Z\",\n \"widgets\": [\n {\n \"widgetId\": \"<string>\",\n \"layout\": {\n \"x\": 5,\n \"y\": 500,\n \"w\": 6,\n \"h\": 4\n },\n \"order\": 1073741823\n }\n ],\n \"filters\": [\n {\n \"id\": \"<string>\",\n \"field\": \"FeedbackRecords.sourceName\",\n \"label\": \"<string>\",\n \"values\": [\n \"Website\"\n ]\n }\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("cookie", "next-auth.session-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.formbricks.com/api/v3/dashboards/{dashboardId}")
.header("cookie", "next-auth.session-token=")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"expectedUpdatedAt\": \"2023-11-07T05:31:56Z\",\n \"widgets\": [\n {\n \"widgetId\": \"<string>\",\n \"layout\": {\n \"x\": 5,\n \"y\": 500,\n \"w\": 6,\n \"h\": 4\n },\n \"order\": 1073741823\n }\n ],\n \"filters\": [\n {\n \"id\": \"<string>\",\n \"field\": \"FeedbackRecords.sourceName\",\n \"label\": \"<string>\",\n \"values\": [\n \"Website\"\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.formbricks.com/api/v3/dashboards/{dashboardId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["cookie"] = 'next-auth.session-token='
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"expectedUpdatedAt\": \"2023-11-07T05:31:56Z\",\n \"widgets\": [\n {\n \"widgetId\": \"<string>\",\n \"layout\": {\n \"x\": 5,\n \"y\": 500,\n \"w\": 6,\n \"h\": 4\n },\n \"order\": 1073741823\n }\n ],\n \"filters\": [\n {\n \"id\": \"<string>\",\n \"field\": \"FeedbackRecords.sourceName\",\n \"label\": \"<string>\",\n \"values\": [\n \"Website\"\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"workspaceId": "<string>",
"name": "<string>",
"creator": {
"name": "<string>"
},
"filters": [
{
"id": "<string>",
"field": "FeedbackRecords.sourceName",
"operator": "equals",
"label": "<string>",
"values": [
"Website"
]
}
],
"widgets": [
{
"id": "<string>",
"chartId": "<string>",
"layout": {
"x": 5,
"y": 500,
"w": 6,
"h": 4
},
"order": 1,
"chart": {
"id": "<string>",
"workspaceId": "<string>",
"datasetId": "<string>",
"name": "<string>",
"type": "area",
"query": {
"measures": [
"FeedbackRecords.npsScore"
],
"dimensions": [
"FeedbackRecords.sourceName"
],
"timeDimensions": [
{
"dimension": "FeedbackRecords.collectedAt",
"granularity": "hour",
"dateRange": "last 30 days"
}
],
"filters": [
{
"member": "FeedbackRecords.sourceType",
"operator": "equals",
"values": [
"<string>"
]
}
],
"order": [
[
"<string>",
"asc"
]
],
"limit": 2500,
"offset": 5000
},
"config": {
"barOrientation": "vertical",
"pieDisplay": "pie",
"areaDisplay": "filled",
"matrixCellValue": "percent",
"matrixColorScale": true,
"matrixShowTotals": true,
"matrixTranspose": true,
"colors": [
"<string>"
],
"xAxisLabel": "<string>",
"yAxisLabel": "<string>",
"showLegend": true,
"legendPosition": "top",
"stacked": true,
"showGrid": true,
"showValues": true,
"numberFormat": "<string>",
"dateFormat": "<string>",
"prefix": "<string>",
"suffix": "<string>"
},
"creator": {
"name": "<string>"
},
"dashboards": [
{
"id": "<string>",
"name": "<string>"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"requestId": "<string>",
"type": "<string>",
"instance": "<string>",
"code": "ai_features_not_enabled",
"details": {},
"invalid_params": [
{
"name": "<string>",
"reason": "<string>",
"code": "dangling_reference",
"identifier": "<string>",
"referenceType": "block",
"missingId": "<string>",
"firstUsedAt": "<string>",
"conflictsWith": "<string>"
}
]
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"requestId": "<string>",
"type": "<string>",
"instance": "<string>",
"code": "ai_features_not_enabled",
"details": {},
"invalid_params": [
{
"name": "<string>",
"reason": "<string>",
"code": "dangling_reference",
"identifier": "<string>",
"referenceType": "block",
"missingId": "<string>",
"firstUsedAt": "<string>",
"conflictsWith": "<string>"
}
]
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"requestId": "<string>",
"type": "<string>",
"instance": "<string>",
"code": "ai_features_not_enabled",
"details": {},
"invalid_params": [
{
"name": "<string>",
"reason": "<string>",
"code": "dangling_reference",
"identifier": "<string>",
"referenceType": "block",
"missingId": "<string>",
"firstUsedAt": "<string>",
"conflictsWith": "<string>"
}
]
}{
"title": "Conflict",
"status": 409,
"detail": "The dashboard changed since your read, so nothing was saved. Read it again, then retry.",
"code": "conflict",
"requestId": "6f1f7f3e-3b0e-4a1a-9f0a-7c9a1d2b3c4d",
"details": {
"expectedUpdatedAt": "2026-10-22T10:00:00.000Z",
"currentUpdatedAt": "2026-10-22T11:30:00.000Z"
}
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"requestId": "<string>",
"type": "<string>",
"instance": "<string>",
"code": "ai_features_not_enabled",
"details": {},
"invalid_params": [
{
"name": "<string>",
"reason": "<string>",
"code": "dangling_reference",
"identifier": "<string>",
"referenceType": "block",
"missingId": "<string>",
"firstUsedAt": "<string>",
"conflictsWith": "<string>"
}
]
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"requestId": "<string>",
"type": "<string>",
"instance": "<string>",
"code": "ai_features_not_enabled",
"details": {},
"invalid_params": [
{
"name": "<string>",
"reason": "<string>",
"code": "dangling_reference",
"identifier": "<string>",
"referenceType": "block",
"missingId": "<string>",
"firstUsedAt": "<string>",
"conflictsWith": "<string>"
}
]
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"requestId": "<string>",
"type": "<string>",
"instance": "<string>",
"code": "ai_features_not_enabled",
"details": {},
"invalid_params": [
{
"name": "<string>",
"reason": "<string>",
"code": "dangling_reference",
"identifier": "<string>",
"referenceType": "block",
"missingId": "<string>",
"firstUsedAt": "<string>",
"conflictsWith": "<string>"
}
]
}Save a whole dashboard
Replaces a dashboard’s name and every widget’s place in one transaction — all of it or none of
it. A widget left out is removed; its chart is kept. Widgets may leave gaps but not overlap (422).
Send the updatedAt from your read as expectedUpdatedAt: if the dashboard changed since, the save
is refused with 409 and nothing is written. Needs write access to the dashboard’s workspace.
filters, when sent, replace the dashboard’s filters. A filter on an embedded-data field
(FeedbackRecords.ed_*) must name a key that the Feedback Dataset of at least one widget the save
keeps has; otherwise the save answers 422 naming filters[<index>].field with
invalid_reference. A filter already saved on the dashboard is not asked again, so it keeps
saving after its key leaves every chart.
curl --request PUT \
--url https://app.formbricks.com/api/v3/dashboards/{dashboardId} \
--header 'Content-Type: application/json' \
--cookie next-auth.session-token= \
--data '
{
"name": "<string>",
"expectedUpdatedAt": "2023-11-07T05:31:56Z",
"widgets": [
{
"widgetId": "<string>",
"layout": {
"x": 5,
"y": 500,
"w": 6,
"h": 4
},
"order": 1073741823
}
],
"filters": [
{
"id": "<string>",
"field": "FeedbackRecords.sourceName",
"label": "<string>",
"values": [
"Website"
]
}
]
}
'import requests
url = "https://app.formbricks.com/api/v3/dashboards/{dashboardId}"
payload = {
"name": "<string>",
"expectedUpdatedAt": "2023-11-07T05:31:56Z",
"widgets": [
{
"widgetId": "<string>",
"layout": {
"x": 5,
"y": 500,
"w": 6,
"h": 4
},
"order": 1073741823
}
],
"filters": [
{
"id": "<string>",
"field": "FeedbackRecords.sourceName",
"label": "<string>",
"values": ["Website"]
}
]
}
headers = {
"cookie": "next-auth.session-token=",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {cookie: 'next-auth.session-token=', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
expectedUpdatedAt: '2023-11-07T05:31:56Z',
widgets: [{widgetId: '<string>', layout: {x: 5, y: 500, w: 6, h: 4}, order: 1073741823}],
filters: [
{
id: '<string>',
field: 'FeedbackRecords.sourceName',
label: '<string>',
values: ['Website']
}
]
})
};
fetch('https://app.formbricks.com/api/v3/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.formbricks.com/api/v3/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>',
'expectedUpdatedAt' => '2023-11-07T05:31:56Z',
'widgets' => [
[
'widgetId' => '<string>',
'layout' => [
'x' => 5,
'y' => 500,
'w' => 6,
'h' => 4
],
'order' => 1073741823
]
],
'filters' => [
[
'id' => '<string>',
'field' => 'FeedbackRecords.sourceName',
'label' => '<string>',
'values' => [
'Website'
]
]
]
]),
CURLOPT_COOKIE => "next-auth.session-token=",
CURLOPT_HTTPHEADER => [
"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.formbricks.com/api/v3/dashboards/{dashboardId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"expectedUpdatedAt\": \"2023-11-07T05:31:56Z\",\n \"widgets\": [\n {\n \"widgetId\": \"<string>\",\n \"layout\": {\n \"x\": 5,\n \"y\": 500,\n \"w\": 6,\n \"h\": 4\n },\n \"order\": 1073741823\n }\n ],\n \"filters\": [\n {\n \"id\": \"<string>\",\n \"field\": \"FeedbackRecords.sourceName\",\n \"label\": \"<string>\",\n \"values\": [\n \"Website\"\n ]\n }\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("cookie", "next-auth.session-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.formbricks.com/api/v3/dashboards/{dashboardId}")
.header("cookie", "next-auth.session-token=")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"expectedUpdatedAt\": \"2023-11-07T05:31:56Z\",\n \"widgets\": [\n {\n \"widgetId\": \"<string>\",\n \"layout\": {\n \"x\": 5,\n \"y\": 500,\n \"w\": 6,\n \"h\": 4\n },\n \"order\": 1073741823\n }\n ],\n \"filters\": [\n {\n \"id\": \"<string>\",\n \"field\": \"FeedbackRecords.sourceName\",\n \"label\": \"<string>\",\n \"values\": [\n \"Website\"\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.formbricks.com/api/v3/dashboards/{dashboardId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["cookie"] = 'next-auth.session-token='
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"expectedUpdatedAt\": \"2023-11-07T05:31:56Z\",\n \"widgets\": [\n {\n \"widgetId\": \"<string>\",\n \"layout\": {\n \"x\": 5,\n \"y\": 500,\n \"w\": 6,\n \"h\": 4\n },\n \"order\": 1073741823\n }\n ],\n \"filters\": [\n {\n \"id\": \"<string>\",\n \"field\": \"FeedbackRecords.sourceName\",\n \"label\": \"<string>\",\n \"values\": [\n \"Website\"\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"workspaceId": "<string>",
"name": "<string>",
"creator": {
"name": "<string>"
},
"filters": [
{
"id": "<string>",
"field": "FeedbackRecords.sourceName",
"operator": "equals",
"label": "<string>",
"values": [
"Website"
]
}
],
"widgets": [
{
"id": "<string>",
"chartId": "<string>",
"layout": {
"x": 5,
"y": 500,
"w": 6,
"h": 4
},
"order": 1,
"chart": {
"id": "<string>",
"workspaceId": "<string>",
"datasetId": "<string>",
"name": "<string>",
"type": "area",
"query": {
"measures": [
"FeedbackRecords.npsScore"
],
"dimensions": [
"FeedbackRecords.sourceName"
],
"timeDimensions": [
{
"dimension": "FeedbackRecords.collectedAt",
"granularity": "hour",
"dateRange": "last 30 days"
}
],
"filters": [
{
"member": "FeedbackRecords.sourceType",
"operator": "equals",
"values": [
"<string>"
]
}
],
"order": [
[
"<string>",
"asc"
]
],
"limit": 2500,
"offset": 5000
},
"config": {
"barOrientation": "vertical",
"pieDisplay": "pie",
"areaDisplay": "filled",
"matrixCellValue": "percent",
"matrixColorScale": true,
"matrixShowTotals": true,
"matrixTranspose": true,
"colors": [
"<string>"
],
"xAxisLabel": "<string>",
"yAxisLabel": "<string>",
"showLegend": true,
"legendPosition": "top",
"stacked": true,
"showGrid": true,
"showValues": true,
"numberFormat": "<string>",
"dateFormat": "<string>",
"prefix": "<string>",
"suffix": "<string>"
},
"creator": {
"name": "<string>"
},
"dashboards": [
{
"id": "<string>",
"name": "<string>"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"requestId": "<string>",
"type": "<string>",
"instance": "<string>",
"code": "ai_features_not_enabled",
"details": {},
"invalid_params": [
{
"name": "<string>",
"reason": "<string>",
"code": "dangling_reference",
"identifier": "<string>",
"referenceType": "block",
"missingId": "<string>",
"firstUsedAt": "<string>",
"conflictsWith": "<string>"
}
]
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"requestId": "<string>",
"type": "<string>",
"instance": "<string>",
"code": "ai_features_not_enabled",
"details": {},
"invalid_params": [
{
"name": "<string>",
"reason": "<string>",
"code": "dangling_reference",
"identifier": "<string>",
"referenceType": "block",
"missingId": "<string>",
"firstUsedAt": "<string>",
"conflictsWith": "<string>"
}
]
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"requestId": "<string>",
"type": "<string>",
"instance": "<string>",
"code": "ai_features_not_enabled",
"details": {},
"invalid_params": [
{
"name": "<string>",
"reason": "<string>",
"code": "dangling_reference",
"identifier": "<string>",
"referenceType": "block",
"missingId": "<string>",
"firstUsedAt": "<string>",
"conflictsWith": "<string>"
}
]
}{
"title": "Conflict",
"status": 409,
"detail": "The dashboard changed since your read, so nothing was saved. Read it again, then retry.",
"code": "conflict",
"requestId": "6f1f7f3e-3b0e-4a1a-9f0a-7c9a1d2b3c4d",
"details": {
"expectedUpdatedAt": "2026-10-22T10:00:00.000Z",
"currentUpdatedAt": "2026-10-22T11:30:00.000Z"
}
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"requestId": "<string>",
"type": "<string>",
"instance": "<string>",
"code": "ai_features_not_enabled",
"details": {},
"invalid_params": [
{
"name": "<string>",
"reason": "<string>",
"code": "dangling_reference",
"identifier": "<string>",
"referenceType": "block",
"missingId": "<string>",
"firstUsedAt": "<string>",
"conflictsWith": "<string>"
}
]
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"requestId": "<string>",
"type": "<string>",
"instance": "<string>",
"code": "ai_features_not_enabled",
"details": {},
"invalid_params": [
{
"name": "<string>",
"reason": "<string>",
"code": "dangling_reference",
"identifier": "<string>",
"referenceType": "block",
"missingId": "<string>",
"firstUsedAt": "<string>",
"conflictsWith": "<string>"
}
]
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"requestId": "<string>",
"type": "<string>",
"instance": "<string>",
"code": "ai_features_not_enabled",
"details": {},
"invalid_params": [
{
"name": "<string>",
"reason": "<string>",
"code": "dangling_reference",
"identifier": "<string>",
"referenceType": "block",
"missingId": "<string>",
"firstUsedAt": "<string>",
"conflictsWith": "<string>"
}
]
}Authorizations
Body
The whole edited dashboard: its name, every widget's place and, optionally, its filters. A widget left out of widgets is removed (its chart is kept); without filters the saved ones are kept. expectedUpdatedAt is the dashboard's updatedAt from your read; if it changed since, nothing is saved.
Response
The saved dashboard
Was this page helpful?