Update Current User Settings

PUT/api/v2/users/me/settings

Use it in a workflow

Add a step and choose the Zendesk connector.
Pick the Update Current User Settings action (under Users).
Fill in the fields below, then reference the result from later steps as {{updateCurrentUserSettings.response.data}}.

Request

Request body

Enter the body as JSON in the step's Body field.

settingsobjectrequired

User settings to update

admin_centerobject1 fields

Admin Center UI settings for onboarding and preferences

agent_home_pinned_viewsarray<integer>

Ordered list of view IDs pinned in the Agent Home sidebar (max 8)

lotusobject5 fields

Lotus UI settings for onboarding, tooltips, and feature preferences

shared_views_orderarray<integer>

Order of shared views (array of view IDs)

json

{
  "settings": {
    "admin_center": {
      "has_admin_center_side_nav_open": false
    },
    "agent_home_pinned_views": [
      0
    ],
    "lotus": {
      "agent_workspace_theme_preference": "0",
      "agent_workspace_theme_preference_for_conversation_panel": "0",
      "keyboard_shortcuts_enabled": false,
      "macro_shortcuts_enabled": false,
      "show_onboarding_tooltips": false
    },
    "shared_views_order": [
      0
    ]
  }
}

Response

Returns 200 with an object. Read it in later steps with {{updateCurrentUserSettings.response.data.<field>}}.

settingsobject

User settings

admin_centerobject1 fields

Admin Center UI settings

agent_home_pinned_viewsarray<integer>

Ordered list of view IDs pinned in the Agent Home sidebar (max 8)

lotusobject6 fields

Lotus UI settings for onboarding, tooltips, and feature preferences

shared_views_orderarray<integer>

Order of shared views (array of view IDs)

json

{
  "settings": {
    "admin_center": {
      "has_admin_center_side_nav_open": false
    },
    "agent_home_pinned_views": [
      0
    ],
    "lotus": {
      "agent_workspace_theme_preference": "0",
      "agent_workspace_theme_preference_for_conversation_panel": "0",
      "keyboard_shortcuts_enabled": false,
      "macro_shortcuts_enabled": false,
      "show_onboarding_tooltips": false,
      "two_factor_authentication": false
    },
    "shared_views_order": [
      0
    ]
  }
}

Need more? See the Zendesk guide for connection setup and behaviour shared by every action.

Was this page helpful?