Saves the widget order and visibility for a specific company dashboard.

post

https://example.com/wep/companies/{companyId}/dashboard

Access: System, Admin, and ClientAdmin users only.

The request body supplies the widgets that should remain on the company dashboard together with their visibility flags, in the order they should be persisted.

On success, the endpoint returns the refreshed company dashboard definition and triggers dashboard-order webhook notifications for the affected company dashboard.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

companyId

int32

required

Company identifier whose dashboard layout should be updated.

Body Params

Ordered widget definitions to persist for the specified company dashboard layout.

Request payload used to persist the order and visibility of dashboard widgets.

items

array of objects | null

Widgets that should remain on the dashboard, in the exact order they should be saved.

items

Headers

api-version

string

required

Defaults to 2.0

The requested API version

x-api-version

string

Defaults to 2.0

The requested API version

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Response

Language

Credentials

Bearer

jwt

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/json

text/plain

200OK