Skip to Content
StoreOSv0.27.1
Core GraphQL APIReferenceMutations

Identity__upsert My Dashboard Layout

Create or replace the current user's dashboard layout. Requires a signed-in staff user.

MUTATIONidentity__upsertMyDashboardLayout(input: UpsertDashboardLayoutInput!): DashboardLayout!

Create or replace the current user's dashboard layout. Requires a signed-in staff user.

Arguments

input*

Returns

  1. identity__upsertMyDashboardLayout
_id*ID!
createdAt?DateTime

A date-time string at UTC, such as 2019-12-03T09:54:33Z, compliant with the date-time format.

scope*DashboardLayoutScope!

Which console dashboard the layout belongs to

Value inADMINMERCHANT
tenant?String
updatedAt?DateTime

A date-time string at UTC, such as 2019-12-03T09:54:33Z, compliant with the date-time format.

userId*String!
widgets*
Example Request
mutation Identity__upsertMyDashboardLayout($input: UpsertDashboardLayoutInput!) {  identity__upsertMyDashboardLayout(input: $input) {    _id    createdAt    scope    tenant    updatedAt    userId    widgets {      id      span      visible    }  }}
Variables
{  "input": {    "scope": "ADMIN",    "widgets": [      {        "id": "string",        "visible": true      }    ]  }}
Example Response
{  "data": {    "identity__upsertMyDashboardLayout": {      "_id": "1",      "createdAt": "<DateTime>",      "scope": "ADMIN",      "tenant": "string",      "updatedAt": "<DateTime>",      "userId": "string",      "widgets": [        {          "id": "string",          "span": "FULL",          "visible": true        }      ]    }  }}