Skip to main content
PUT
cURL

Authorizations

Authorization
string
header
required

For your own scripts and server-to-server integrations. Create a key in the app under Settings > Access > API keys and copy it then, because it is shown once. Send it as Authorization: Bearer <key>. The key acts as the member who made it, in the organization it was made in. A call needs the member's permission and one of the key's scopes, such as inventory:read or sales:write. A key with * has every scope.

Path Parameters

dashboard
string | null
required

Body

application/json

A dashboard to save, or a new version of one: its widgets on a grid of 12 columns and the global filters it opens with.

name
string
required

What the dashboard is called.

Maximum string length: 120
widgets
object[]
required

The widgets on the grid; none is a blank dashboard.

Maximum array length: 50
description
string | null

What it is for, in a sentence.

Maximum string length: 1000
filters
object | null
restored_from
integer | null

The version a restore copied, so history says so.

Required range: x >= 1

Response

DashboardSavedResource

data
DashboardSavedResource · object
required