Development Guides Home >> Guide to cPanel Interface Customization and Branding

Guide to cPanel Interface Customization - Hide the Onboarding Assistant

Introduction

The Onboarding Assistant will display for all new user accounts and all accounts migrated to the Jupiter theme.

Hide the Onboarding Assistant for new users

To hide the Onboarding Assistant for new users, run the following command, where username is the cPanel account name:

Copy

Copied

echo '{"personalization": {"cp-welcome-panel_dismissed": 1}}' | uapi --user=userName --input=json --output=jsonpretty Personalization set

The API response will resemble the following:

Copy

Copied

{
   "apiversion" : 3,
   "module" : "Personalization",
   "result" : {
      "messages" : null,
      "warnings" : null,
      "metadata" : {},
      "errors" : null,
      "data" : {
         "personalization" : {
            "cp-welcome-panel_dismissed" : {
               "success" : 1,
               "value" : 1,
               "reason" : "OK"
            }
         }
      },
      "status" : 1
   },
   "func" : "set"
}

Hide the Onboarding Assistant for migrated users

To hide the Onboarding Assistant for users migrated to the Jupiter theme, run the following command, where username is the cPanel account name:

Copy

Copied

echo '{"personalization": {"migrated_to_jupiter": 0}}' | uapi --user=userName --input=json --output=jsonpretty Personalization set

The API response will resemble the following:

Copy

Copied

{
   "func" : "set",
   "apiversion" : 3,
   "result" : {
      "messages" : null,
      "status" : 1,
      "metadata" : {},
      "errors" : null,
      "data" : {
         "personalization" : {
            "migrated_to_jupiter" : {
               "reason" : "OK",
               "success" : 1,
               "value" : ""
            }
         }
      },
      "warnings" : null
   },
   "module" : "Personalization"
}