Docs/API reference / Dashboards

Update dashboards

Requires `developer_api.dashboards.update` on the project-scoped Developer API connection. Use the API origin supplied for your deployment. Unknown query parameters and unexpected request bodies are rejected. Send only mutable fields. Fields not included in the body remain unchanged. The expected_revision is required. A stale revision produces a 409 conflict. Widget definitions are replaced as a complete saved set when supplied.

PATCH/dev-api/v1/p/{project_id}/dashboards/{dashboard_id}All endpoints ↗

The request panel saves credentials and API settings in this browser. Privacy details

Authorization

developerApiKey

AuthorizationBearer <token>

Project-scoped Developer API connection key. Grant only the required operation permissions.

In: header

Path Parameters

project_id*string

Match.*\S.*

Length1 <= length <= 128

dashboard_id*string

Match.*\S.*

Length1 <= length <= 128

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`application/json`

bash

curl -X PATCH "https://example.com/dev-api/v1/p/string/dashboards/string" \
  -H "Content-Type: application/json" \
  -d '{
    "expected_revision": 1
  }'

json

{
  "request_id": "string",
  "data": {
    "dashboard_id": "string",
    "revision": 1,
    "created_ids": {
      "property1": "stringstringstringstr",
      "property2": "stringstringstringstr"
    }
  }
}

Authorization

Path Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

405application/json

409application/json

413application/json

415application/json

429application/json

500application/json

503application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`