Contact Us
Quote Request
  • App Support
    • Knowledge Base
      • API Documentation
      • Classic Portal Documentation
      • App Developer Account Info
      • Video Tutorials – Classic
      • Onboarding Documentation
      • New Portal Documentation
      • Video Tutorials – New
      • App Version Update Notes
    • App Success Tips
      • App Launch Success Guide​
      • Populate Your App For Launch
      • Train Your App Administrators
      • Prepare and Plan Your Marketing Launch Activities
      • Keep Your App Fresh
      • Consistently Remind Your Community about Your App
      • Turn Your App Administrators into Super-Users
      • Ensure Your App Is a Must-Have for Your Community
  • Additional Services
    • Additional Training
    • Content & Design
      • Blog Posts
      • Infographics
      • Content Packages
      • Assessments
      • Editorial Services
      • Whiteboard Video
    • Marketing Support
Menu
  • App Support
    • Knowledge Base
      • API Documentation
      • Classic Portal Documentation
      • App Developer Account Info
      • Video Tutorials – Classic
      • Onboarding Documentation
      • New Portal Documentation
      • Video Tutorials – New
      • App Version Update Notes
    • App Success Tips
      • App Launch Success Guide​
      • Populate Your App For Launch
      • Train Your App Administrators
      • Prepare and Plan Your Marketing Launch Activities
      • Keep Your App Fresh
      • Consistently Remind Your Community about Your App
      • Turn Your App Administrators into Super-Users
      • Ensure Your App Is a Must-Have for Your Community
  • Additional Services
    • Additional Training
    • Content & Design
      • Blog Posts
      • Infographics
      • Content Packages
      • Assessments
      • Editorial Services
      • Whiteboard Video
    • Marketing Support

API Documentation

  • API Documentation
  • Assessments & Quiz API Sample
  • Forms & Reporting API Sample
  • Side Menu API Sample

Classic Portal Documentation

  • Advantages
  • Alerts
  • Assessments and Quizzes
  • Checklists
  • Content Authoring Tool
  • Creating a Quiz
  • eGuide Library
  • Events
  • FAQ Module
  • Form Elements Breakdown
  • How to Create a Scored Assessment
  • Logging In to Your Portal
  • Module Access Codes
  • News
  • PDF Library
  • Reporting and Forms
  • Resources Module
  • Text Module / Welcome Message
  • User Management
  • Videos

App Developer Account Info

  • Apple Developer Program Letter Request
  • Enrolling in the Apple Developer Program
  • Getting Started with Developer Accounts
  • Granting QuickSeries Access to Your App Store Connect
  • Granting QuickSeries Access to Your Google Play Console
  • Register for a Google Play Developer account
  • Transferring Your App: How to Accept the Transfer
  • Transferring Your App: How to Initiate the Transfer

Video Tutorials - Classic

  • FAQ Module
  • Module Access Codes
  • News Module
  • Reports and Forms

Onboarding Documentation

  • 12 Steps of Onboarding
  • Installing Your Test App on Android (Firebase)
  • Installing Your Test App on iOS (TestFlight)

New Portal Documentation

  • Alerts
  • Assessments
  • Checklists
  • eGuide Library / Bundles
  • FAQ
  • Form Elements Breakdown
  • Forms & Reporting
  • Make Your Plan
  • Maps
  • Module Access Codes
  • News
  • NWS / FEMA Alerts
  • PDF Library
  • Privacy Policy and Terms and Conditions editor
  • QuickConnect Workspaces
  • Resources
  • Side Menu Customization
  • User Management
  • User Onboarding
  • Video Library
  • Welcome Message

Video Tutorials - New

  • Access Codes
  • Alerts Module
  • App User Onboarding
  • Assessment & Quiz Module
  • Checklist Module
  • FAQ Module
  • Library Module
  • Make Your Plan Module
  • Maps: How to create zones
  • News Module
  • NWS and FEMA Alerts
  • Privacy Policy and Terms and Conditions editor
  • QuickConnect Workspaces
  • Reporting Module
  • Resources Module
  • Side Menu Customization
  • Video Library Module
  • Welcome Message Module

App Success Tips

  • App Launch Success Guide​
  • Consistently Remind Your Community about Your App
  • Ensure Your App Is a Must-Have for Your Community
  • Keep Your App Fresh
  • Populate Your App For Launch
  • Prepare and Plan Your Marketing Launch Activities
  • Train Your App Administrators
  • Turn Your App Administrators into Super-Users

App Version Update Notes

  • Version 3.11.0
  • Version 3.11.2
  • Version 3.12.2
  • Version 3.13.2
  • Version 3.7.1
  • Version 3.8.0
  • Version 3.9.0
  • Home
  • Knowledge Base
  • API Documentation

Side Menu API Sample

Table of Contents
  • Full payload example
  • Side menu modules types
Print Friendly, PDF & EmailQuickPrint

The side menu allows us to modify the behaviour of the custom modules, to be shared privately through an Access code or a Private Users. This option allow to create some custom links, being the only modules that can be created for the client.

Full payload example

Here is a rudimentary code sample for update the side menu:

KeyDescriptionTypeRequiredPossible values
eid stringOnly for a modified and remove properties.This value is provided to you after creating a new item. UUID v4 string
coreModuleEidThe EID are predefined, you just need to send the identifiers for the options that you want to collect.stringtrueUUID v4 string
title stringtrueAny string
description stringfalseAny string
link Base on the type, the link represent the value assigned. Base on type property the values could be like:

 

  • phone-link: 123-456-7890
  • external-link: https://domain.com
  • email-link: myemail@domain.com
stringtrueString related to the type. Could be a phone number, url or email.
icon Url of the iconstringtrue 
typeThe only allowed types for creation are defined in possible values column. This property can’t be modified after creation.stringtruephone-link, external-link, email-link
privateThis value allows to share the custom module in an Access Code.booleantrueTo be accessible through the Access Code
userPrivacyThis value allows to share the custom module in a Private user registration module.stringtrue
  • public
  • hidden: Hide from mobile devices.
  • private: To be accessible through the Private User Registration.

Side menu modules types

TypeDescriptioncoreModuleEid Prod ID’scoreModuleEid QA ID’s (for test)
phone-link Add an important phone number to the side menu for instant access.6309ed77-370a-4baf-8145-b8a0e93e0685f1a87b22-81db-4fdb-abe3-b9c376b009fb
external-linkInclude a relevant website in the side menu to quickly access additional information.990eec81-31c5-4434-8467-faf3782e8e60c2c97b53-ef9e-4000-811e-cb957cd42172
email-linkAdd an email address to the side menu for instant access.99573da7-5419-4410-aeaa-7efca775b3a163c75ecc-6749-419b-ad3d-f5ee5f60d115
{
  "added": [
    {
      "eid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "coreModuleEid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "title": "My phone",
      "description": "My home phone number",
      "link": "123-456-7890",
      "icon": "https://s3.amazonaws.com/qs-static-web/assets/v4/qs-ui-icons/Internet-Networks-Servers/Worldwide-Web/network-navigation.svg",
      "type": "phone-link",
      "private": false,
      "userPrivacy": "public"
    }
  ],
  "modified": [
    {
      "eid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "coreModuleEid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "title": "Website",
      "description": "Google website",
      "link": "https://www.google.com/maps",
      "icon": "https://s3.amazonaws.com/qs-static-web/assets/v4/qs-ui-icons/Internet-Networks-Servers/Worldwide-Web/network-navigation.svg",
      "type": "external-link",
      "private": false,
      "userPrivacy": "public"
    }
  ],
  "removed": [
    {
      "eid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "coreModuleEid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "title": "My email",
      "description": "My personal email",
      "link": "myemail@test.com",
      "icon": "https://s3.amazonaws.com/qs-static-web/assets/v4/qs-ui-icons/Internet-Networks-Servers/Worldwide-Web/network-navigation.svg",
      "type": "email-link",
      "private": true,
      "userPrivacy": "public"
    }
  ]
}
Still stuck? How can we help?

How can we help?

Table of Contents
  • Full payload example
  • Side menu modules types

|

Reliable Content.
Innovative Delivery.

App Support

  • Knowledge Base
  • App Success Tips

Additional Services

  • Additional Training
  • Content & Design
  • Marketing Support

Legal

  • Legal Policies
  • SLA Agreement

This website and its contents is copyright of QuickSeries Inc.
© QuickSeries 2021.

All rights reserved. Any redistribution or reproduction of part or all of the contents in any form is prohibited.