PUT
/
project
/
{id}
curl --request PUT \
  --url https://api.chartbrew.com/project/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "dashboardTitle": "<string>",
  "description": "<string>",
  "backgroundColor": "<string>",
  "titleColor": "<string>",
  "headerCode": "<string>",
  "footerCode": "<string>",
  "public": true,
  "passwordProtected": true,
  "timezone": "<string>",
  "updateSchedule": {
    "timezone": "Asia/Bangkok",
    "frequency": "every_x_minutes",
    "frequencyNumber": "1",
    "time": {
      "hour": 9,
      "minute": 0,
      "second": 0,
      "millisecond": 0
    }
  }
}'
{
  "id": 123,
  "team_id": 123,
  "name": "<string>",
  "brewName": "<string>",
  "dashboardTitle": "<string>",
  "description": "<string>",
  "backgroundColor": "#103751",
  "titleColor": "white",
  "headerCode": "<string>",
  "footerCode": "<string>",
  "logo": "<string>",
  "logoLink": "<string>",
  "public": false,
  "passwordProtected": false,
  "timezone": "<string>",
  "updateSchedule": {
    "timezone": "Asia/Bangkok",
    "frequency": "every_x_minutes",
    "frequencyNumber": "1",
    "time": {
      "hour": 9,
      "minute": 0,
      "second": 0,
      "millisecond": 0
    }
  },
  "lastUpdatedAt": "2023-11-07T05:31:56Z",
  "Charts": [
    {
      "id": "<string>",
      "name": "<string>",
      "type": "<string>",
      "subType": "<string>",
      "chartData": {},
      "chartDataUpdated": "2023-11-07T05:31:56Z",
      "project_id": "<string>",
      "public": true,
      "shareable": true,
      "ChartDatasetConfigs": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "chart_id": 123,
          "dataset_id": 123,
          "formula": "<string>",
          "datasetColor": "<string>",
          "fillColor": "<string>",
          "fill": false,
          "multiFill": false,
          "legend": "<string>",
          "pointRadius": 123,
          "excludedFields": [
            "<string>"
          ],
          "sort": "<string>",
          "columnsOrder": [
            "<string>"
          ],
          "order": 0,
          "maxRecords": 123,
          "goal": 123
        }
      ]
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

ID of the dashboard

Body

application/json
backgroundColor
string
dashboardTitle
string
description
string
headerCode
string
name
string
passwordProtected
boolean
public
boolean
timezone
string
titleColor
string
updateSchedule
object

Response

200 - application/json
backgroundColor
string
default:
#103751
brewName
string
Charts
object[]
dashboardTitle
string
description
string
headerCode
string
id
integer
lastUpdatedAt
string
name
string
passwordProtected
boolean
default:
false
public
boolean
default:
false
team_id
integer
timezone
string
titleColor
string
default:
white
updateSchedule
object