PUT/api/v1/me/dashboard

Change your Home layout

Saves your Home in a workspace: main and side (at most 16 widgets in all; keep ids to move one), or a preset (default, writer, meetings, sales, manager) filled in with your own team and newest page. 422 names an unknown type or setting, or a team, folder or page you can't open.

API token required60 per minute per IPMCP: set_dashboard
Code samples and Try it

Request body

#

application/json, required

  • workspacestring

    File it in this workspace: the workspace's id. Up to 40 characters.

  • mainarray of object

    The wide column, top to bottom. Up to 16 items.

    3 fields inside
    • idstring

      Kept when it's a short id; new widgets get one. Up to 12 characters.

    • typestringRequired

      One of the catalog's types (GET returns the catalog). Up to 40 characters.

    • settingsobject

      The type's settings: team, folder, page, count, category, status, range.

  • sidearray of object

    The narrow column, top to bottom. Up to 16 items.

    3 fields inside
    • idstring

      Kept when it's a short id; new widgets get one. Up to 12 characters.

    • typestringRequired

      One of the catalog's types (GET returns the catalog). Up to 40 characters.

    • settingsobject

      The type's settings: team, folder, page, count, category, status, range.

  • presetstring

    Start from a template instead: default, writer, meetings, sales, manager. Up to 20 characters.

Responses

#
  • 200OK.
  • 401No token, or the token is revoked or mistyped.
  • 422The request didn't validate. detail lists each problem, with where it is (loc) and why (msg).
  • 429Too many requests from your IP address. Wait the seconds in Retry-After.
Did this page help?