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.

Body

application/json

A home dashboard to choose, or to take off.

scope
enum<string>
required

organization, for the dashboard every member lands on, or personal, for the person's own.

Available options:
organization,
personal
dashboard_id
string<uuid> | null
required

The dashboard; null takes the choice off.

Response

HomeDashboardResource

data
HomeDashboardResource · object
required