Contact Us
Quote Request

Side Menu API Sample

Table of Contents
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"
    }
  ]
}

|

Reliable Content.
Innovative Delivery.

App Support

Additional Services

Legal