Update dashboard

PUT

/domains/{domain}/users/{user}/dashboards

Last modified:2026-10-05 17:54:31

OperationId:UpdateDashboard

Changes a dashboard, named by id in the body. Only the fields you send change, and the dashboard stays in its own domain.

You can change a dashboard you own. An Office Manager in its domain, a Reseller whose territory holds the domain, and a Super User can change dashboards owned by users with a lower scope than their own. Read-only scopes cannot. A stock dashboard, offered across the platform, can be changed only by a Super User. Sharing a dashboard with someone never lets them change it. Giving the dashboard to another owner needs the same right over that user, and changing owner_type needs Office Manager scope or higher.

A dashboard that is not in the domain in the path returns 404; one you may not change returns 403.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢202Accepted

application/json

The change was accepted and is applied shortly after. The response does not carry the record; read it back to confirm.

Bodyapplication/json

🟠400Bad Request

🟠401Authentication Required

🟠403Forbidden

🟠404Record not found

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'https://awqacore01.crexendocloud.com/ns-api/v2/domains/example.com/users/1001/dashboards' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "id": 42,
    "name": "Support Queue Overview",
    "share_type": "domain"
}'

Response Example

202 - Accepted

{
    "code": 202,
    "message": "Accepted"
}

Modified at 2026-10-05 17:54:31

Create dashboard

Delete dashboard