Configuration Param API

Configuration Param API

Extensions can make use of Configuration Param API to access & modify the extension's config params. The available storage API's are,
  1. Add config params
  2. Get config param                 

#CONFIG_PARAM_API_REQUEST_OBJECT

            
  1. {
  2.   "variables" : [
  3.     {
  4.       "name"  : "configParam1",
  5.       "value" : "value for the configparam 1"
  6.     },
  7.     {
  8.       "name"   : "configParam3",
  9.       "value"  : "value for the configparam 3"
  10.     }
  11.   ]
  12. }

#CONFIG_PARAM


  1. {
  2.   "data" : [
  3.     {
  4.       "defaultValue" : "default1",
  5.       "userDefined" : true,
  6.       "name" : "variable1",
  7.       "options" : "[op1,  opt2]",
  8.       "secure" : true,
  9.       "type" : "text",
  10.       "mandatory" : false,
  11.       "value" : "testing",
  12.       "varId" : "4000000011017"
  13.     }
  14.   ]
  15. }

Add or update config params

Use this API to add or update config params.

Request Format:
URL             :     https://desk.zoho.com/api/v1/installedExtensions/{{installationId}}/configParams
OAuth Scope     :     Desk.extensions.CREATE
RequestMethod   :     POST
RequestHeaders  :     orgId, Authorization
Content-Type    :     application/json
RequestBody     :     #CONFIG_PARAM_API_REQUEST_OBJECT.                       
                            
Response Format:
ResponseCode    : 200
Content-Type    : application/json
Response        : #CONFIG_PARAM_API_RESPONSE_OBJECT
                        

Get config params

Use this API to get extension's config params.

Request Format:
URL             :     https://desk.zoho.com/api/v1/installedExtensions/{{installationId}}/configParams
OAuth Scope     :     Desk.extensions.READ
RequestMethod   :     GET
RequestHeaders  :     orgId, Authorization
                                                  
Response Format:
ResponseCode    : 200
Content-Type    : application/json
Response        : #CONFIG_PARAM_API_RESPONSE_OBJECT


    Zoho CRM Training Programs

    Learn how to use the best tools for sales force automation and better customer engagement from Zoho's implementation specialists.

    Zoho CRM Training
      Redefine the way you work
      with Zoho Workplace

        Zoho DataPrep Personalized Demo

        If you'd like a personalized walk-through of our data preparation tool, please request a demo and we'll be happy to show you how to get the best out of Zoho DataPrep.

        Zoho CRM Training

          Create, share, and deliver

          beautiful slides from anywhere.

          Get Started Now


            Zoho Sign now offers specialized one-on-one training for both administrators and developers.

            BOOK A SESSION








                                You are currently viewing the help pages of Qntrl’s earlier version. Click here to view our latest version—Qntrl 3.0's help articles.




                                    Manage your brands on social media

                                      Zoho Desk Resources

                                      • Desk Community Learning Series


                                      • Digest


                                      • Functions


                                      • Meetups


                                      • Kbase


                                      • Resources


                                      • Glossary


                                      • Desk Marketplace


                                      • MVP Corner


                                      • Word of the Day


                                        Zoho Marketing Automation

                                          Zoho Sheet Resources

                                           

                                              Zoho Forms Resources


                                                Secure your business
                                                communication with Zoho Mail


                                                Mail on the move with
                                                Zoho Mail mobile application

                                                  Stay on top of your schedule
                                                  at all times


                                                  Carry your calendar with you
                                                  Anytime, anywhere




                                                        Zoho Sign Resources

                                                          Sign, Paperless!

                                                          Sign and send business documents on the go!

                                                          Get Started Now




                                                                  Zoho TeamInbox Resources



                                                                          Zoho DataPrep Resources



                                                                            Zoho DataPrep Demo

                                                                            Get a personalized demo or POC

                                                                            REGISTER NOW


                                                                              Design. Discuss. Deliver.

                                                                              Create visually engaging stories with Zoho Show.

                                                                              Get Started Now







                                                                                            You are currently viewing the help articles of Sprints 1.0. If you are a user of 2.0, please refer here.

                                                                                            You are currently viewing the help articles of Sprints 2.0. If you are a user of 1.0, please refer here.



                                                                                                  • Related Articles

                                                                                                  • Configuration

                                                                                                    Introduction Channel Integration lets you to sync data such as tickets, threads and contacts between Zoho Desk and External Services. It also lets the agents to send replies to the queries on external platforms directly from the desk. Channel ...
                                                                                                  • API Limits

                                                                                                    To use the Vertical Solution API, you'll require the Authentication Token from your CRM account. Please make sure that you have the permission to access the API service. If you do not have permission, please contact your CRM administrator. API Limit ...
                                                                                                  • Storage API

                                                                                                    Extensions can make use of Storage API to access & modify data from the extension's DB storage. The available storage API 's are, Add data to storage Get data from storage Delete data from storage #STORAGE_DATA_OBJECT Every storage object has the ...
                                                                                                  • Request API

                                                                                                    This API avoid CORS-related issues and successfully run third-party APIs from the extension. Request var reqObj= {       url : 'http://demo2022863.mockable.io/test',       headers : { 'Content-Type' : 'application/json' },       type : 'GET',       ...
                                                                                                  • API Methods

                                                                                                    Method Name Description getMyRecords To retrieve data by the owner of the Authentication Token specified in the API request getRecords To retrieve all users data specified in the API request getRecordById To retrieve individual records by record ID ...
                                                                                                    Wherever you are is as good as
                                                                                                    your workplace

                                                                                                      Resources

                                                                                                      Videos

                                                                                                      Watch comprehensive videos on features and other important topics that will help you master Zoho CRM.



                                                                                                      eBooks

                                                                                                      Download free eBooks and access a range of topics to get deeper insight on successfully using Zoho CRM.



                                                                                                      Webinars

                                                                                                      Sign up for our webinars and learn the Zoho CRM basics, from customization to sales force automation and more.



                                                                                                      CRM Tips

                                                                                                      Make the most of Zoho CRM with these useful tips.



                                                                                                        Zoho Show Resources