Storage API

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,

  1. Add data to storage
  2. Get data from storage
  3. Delete data from storage

#STORAGE_DATA_OBJECT

Every storage object has the following properties.    
                            
#STORAGE_DATA_OBJECT
  1. {
  2.     "key"            : "color-red-data-id-278783",
  3.     "queriableValue" : "color-red-datas",
  4.     "value"          : {
  5.         "myResult" : "Diluted solution for red color experiment 128ml "
  6.     }

  7. }



Add data to storage

Use this API to add data to the extension storage.

Add data to storage:
Request Format:

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


Get data from storage

Use this API to get data from the extension storage with the matching criteria.

Get data from storage:
Request Format:
URL             :     https://desk.zoho.com/api/v1/installedExtensions/{{installationId}}/storage
OAuth Scope     :     Desk.extensions.READ
RequestMethod   :     GET
RequestHeaders  :     orgId, Authorization
QueryParams     :     key, queriableValue, from, limit                            
                            
Response Format:
ResponseCode    : 200
Content-Type    : application/json
Response        : JSONObject with data property
                  containing the result as array of #STORAGE_DATA_OBJECT.


Delete data from storage

Use this API to delete data from the extension storage specifying the key.

Delete data from storage:
Request Format:
URL             :     https://desk.zoho.com/api/v1/installedExtensions/{{installationId}}/storage
OAuth Scope     :     Desk.extensions.DELETE
RequestMethod   :     DELETE
RequestHeaders  :     orgId, Authorization
QueryParams     :     key
                            
                            
Response Format:
ResponseCode    : 200




    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 Param API

                                                                                                    Extensions can make use of Configuration Param API to access & modify the extension's config params. The available storage API's are, Add config params Get config param                  #CONFIG_PARAM_API_REQUEST_OBJECT              {   "variables" : ...
                                                                                                  • Data Storage APIs

                                                                                                    Sometimes, the extensions you create might require data storage and retrieval capabilities. To help you in such cases, we provide a data store for extensions to set (store) and get (retrieve) data. The data can be deleted when it is no longer ...
                                                                                                  • Desk Invoke API

                                                                                                    Desk's invoke API acts as a proxy between the extension and the External Services or Desk for calling the APIs. With Desk Invoke API, Can access the Zoho Desk's APIs Can access the External Services's APIs Can access the Extension Data Specific APIs ...
                                                                                                  • Data Storage Add-on in Vertical Solutions

                                                                                                    Within Vertical Solutions, the storage space is divided into two key categories - Data and File. These categories are further classified into Storage and Usage details. In this section, let us see in detail about Data Storage, and how you can buy ...
                                                                                                  • 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 ...
                                                                                                    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