Create, edit, disable and delete Function API

Create, edit, disable and delete Function API

Feature Availability

Who can create a Function API? 

By default, only the network admins can create a Function API. However, if allowed, selected users can also create a Function API.

How do I create a Function API configuration?  

  1. Click the gear icon [] in the right menu.
  2. Select Settings from the dropdown.
  3. In the Settings page, click Function API under Developer Space.

  4. In the new page, click Create Configuration.
     
  5. In the Configuration Details page, give a name, icon, and description.
  6. Click Save & edit code.
  7. Write a custom function to define how the request should be handled in the respective handlers.
  8. Once done, click Expand next to API endpoint.
  9. Click Generate URL.

  10. Copy the URL and paste it in the other application from which the request is constructed.
User can create a maximum of 20 Function API configurations each. 

How do I edit a Function API configuration? 

  1. Click the gear icon [] in the right menu.
  2. Select Settings from the dropdown.
  3. In the Settings page, click Function API under Developer Space.
     
  4. From the list of configurations, select the required one.
  5. In the Configuration Details pop-out, click Edit Configuration.
  6. Make the required edits and click Save.

How do I disable or delete a Function API configuration?

Disabling the Function API will suspend it temporarily. To disable, follow the steps below:
  1. Click the gear icon [] in the right menu.
  2. Select Settings from the dropdown.
  3. In the Settings page, click Function API under Developer Space.
  4. From the list of configurations, select the required one.
  5. To disable the configuration, toggle the button in the top-right corner of the Configuration Details pop-up.
  6. To delete the configuration, click the trash icon [] in the top-right corner of the Configuration Details pop-up.
Disable the Function API configuration while making changes to the handler code to prevent unwanted invocation.

Execution Logs

The logs in each Function API configuration lists the details of every request handler execution and its results for the past one year. The details include execution time, status, parameters passed, and the data returned by the function. These logs can be used to analyze and debug issues in the API execution. 
 
To view logs:
  1. Click the gear icon [] in the right menu.
  2. Select Settings from the dropdown.
  3. In the Settings page, select Function API under Developer Space.
  4. From the list of configurations, select the required one.
  5. In the Configuration Details pop-out, click Edit Configuration.

  6. Scroll down to the bottom of the page and click Expand next to Logs.

Execution Limit

There is a limit on the number of API executions that are made in a network per day. This limit differs with each subscription plan and can be increased by either upgrading to a higher plan or contacting the Zoho Connect support team. Once you have exhausted the maximum limit, all Function APIs in your network will stop working for the rest of the day and, they will resume functioning by 12.00 AM based on your network's data center location. 
 
To view the execution details:
  1. Click the gear icon [] in the right menu.
  2. Select Settings from the dropdown.
  3. In the Settings page, select Function API under Developer Space.
  4. You'll see the usage details in the top-right corner of the page.
 
If you have any questions regarding Function API, please write to us at support@zohoconnect.com.
 
 


    Access your files securely from anywhere

      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









                                                                                                              • Related Articles

                                                                                                              • An example for Function API

                                                                                                                Let us consider an example in which a new task is created in Zoho Connect whenever a ticket is added in Zoho Desk. This is implemented using an Outgoing Webhook in Zoho Desk that will make a POST request to an API endpoint in Zoho Connect. But Desk's ...
                                                                                                              • Overview of Function API

                                                                                                                Feature Availability Overview Function API in Zoho Connect provides an authenticated API endpoint to establish a connection between two applications and automate workflows. It also includes handlers that let you format the request and response ...
                                                                                                              • Regenerating the API endpoint URL

                                                                                                                Feature Availability Overview The API endpoint is an authenticated URL that lets another service to send requests and access the data in a network. It is necessary that the URL is kept safe and not shared with others. However, in case the URL gets ...
                                                                                                              • Add, edit, resize, and remove widgets

                                                                                                                Feature Availability Overview Zoho Connect has 50 widgets so that every important information is available on the network dashboard. This document covers how to add, customize, and remove a widget. How do I add a widget to the network dashboard? ...
                                                                                                              • Disable data export in Groups, Manuals, and Boards

                                                                                                                Overview Members who are admins of a Group, Board, or Manual can export data from it. However, network admins can restrict users from exporting data.  How to disable data export in Groups, Manuals, and Boards?  Click the gear icon  from the menu in ...
                                                                                                                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