Overview

Updates the metadata for a module's dashboard tab to the default metadata.

Summary

This endpoint is used to restore the default metadata for a module's dashboard tab.

Request Arguments

Name Type Description Required
dashboard string The dashboard name (e.g. omnichannel, multi-line, record) True
tab_index string The index of the tab to restore (e.g. 0, 1, 2) True
dashboard_module string The module the dashboard belongs to (e.g. Accounts, Cases, Dashboards) False

Request

{
    "dashboard":"omnichannel",
    "tab_index":"0"
}

Response Example

{
    "id":"123",
    "name":"LBL_OMNICHANNEL_DASHBOARD",
    "dashboard_module": "Dashboards",
    "view_name": "omnichannel",
    "metadata": {
        "buttons": {...},
        "tabs": {...}
    },
    ...
}

Change Log

Version Change
v11.12 Added /Dashboards/<id>/restore-tab-metadata PUT endpoint.