Kaizen #74 - User's Unavailability #APIs

Kaizen #74 - User's Unavailability #APIs

Hello everyone!
Welcome back to this week's post in the Kaizen series on User's Unavailability APIs.

Business and meetings go hand in hand. There are times when you attend a meeting with your clients or partners on a weekday and during the working hours. 
During such times, Zoho CRM gives you the option to mark yourself unavailable, so that you do not get invited to other meetings or calls. 
 
When you have synced Zoho CRM's calendar with an external system, these APIs allow you to ensure that the data is up to date in both places so you never miss a meeting because of date and time conflicts.

Additionally, if you are the admin, you are at liberty to view the details of the availability of other users, too.
Let us now discuss these APIs in detail.

Mark your unavailability

Use this API to mark yourself unavailable during a set period.

Request URL: {api-domain}/crm/v4/settings/users_unavailability
Request Method: POST
Scope: ZohoCRM.settings.users_unavailability.ALL/WRITE

Input Body:

{
    "users_unavailability": [
        {
            "comments": "Unavailable during this time. Please schedule a call later.",
            "from": "2023-02-28T19:00:00+05:30",
            "to": "2023-03-10T20:00:00+05:30",
            "user": {
                "name": "Patricia Boyle",
                "id": "554xxxx966",
                "zuid": "554xxx5011"
            }
        }
    ]
}


Key
Description
comments
string, optional
Any comment you want to add to describe your unavailability.
from
string, mandatory
The date and time(in the ISO8601 format) from which you will be unavailable. 
to
string, mandatory
The date and time(in the ISO8601 format) after which you will be available.
user
JSON object
The name(optional), ID(from the Get users API, mandatory), and zuid(from the Get users API, optional)

Response:

{
    "users_unavailability": [
        {
            "code": "SUCCESS",
            "details": {
                "id": "3652397000011056002"
            },
            "message": "Unavailability created successfully.",
            "status": "success"
        }
    ]
}

Update your unavailability

Use this API to update the details of your unavailability.

Request URL: {api-domain}/crm/v4/settings/users_unavailability or {api-domain}/crm/v4/settings/users_unavailability/{id}
Request Method: PUT
Scope: ZohoCRM.settings.users_unavailability.ALL/UPDATE

Input Body:

{
    "users_unavailability": [
        {
            "comments": "Unavailable - Updated the 'from' time",
            "from": "2023-03-01T15:00:00+05:30",
            "id": "3652397000011056002"
        }
    ]
}

Response:

{
    "users_unavailability": [
        {
            "code": "SUCCESS",
            "details": {
                "id": "3652397000011056002"
            },
            "message": "Unavailability updated successfully.",
            "status": "success"
        }
    ]
}

Delete your unavailability

Use this API to delete the details of your unavailability.

Request URL: {api-domain}/crm/v4/settings/users_unavailability/{id}
Request Method: DELETE
Scope: ZohoCRM.settings.users_unavailability.ALL/DELETE

Response:

{
    "users_unavailability": [
        {
            "code": "SUCCESS",
            "details": {
                "id": "3652397000011056002"
            },
            "message": "Unavailability deleted Successfully",
            "status": "success"
        }
    ]
}

Get a user's unavailability

Use this API to get the details of the unavailability of a user. 
Only admins can get the details of all users, while non-admin users can only fetch their own details.

Request URL: {api-domain}/crm/v4/settings/users_unavailability
Request Method: GET
Scope: ZohoCRM.settings.users_unavailability.ALL/GET
Optional Parameters: 
  • group_ids - The unique ID of the user group that the user belongs to. To fetch the details of the user from multiple groups, you can give the IDs as comma-separated values.
  • role_ids - The unique ID of the role that the user belongs to. To get the users from multiple roles, input their role IDs as comma-separated values.
  • territory_ids - The unique ID of the territory that the user is a part of. To get the users belonging to multiple territories, input their territory IDs as comma-separated values. 
  • include_inner_details - Use this parameter to get the user's ZUID in the response. The value for this parameter is user.zuid 
  • filters - The criteria to filter the users based on the time they will be unavailable. You can filter using groups and comparators as follows:
  • group - Contains the comparator, value and the API name of the field based on which you want to filter the results. The allowed comparators are equals, not_equals, between, greater_than, greater_equal, less_than, and less_equal.
  • group_operator - The operator AND or OR.
    Note that the value of this parameter must be encoded.
    Example: filters=%7B%22comparator%22%3A%22equal%22%2C%22field%22%3A%7B%22api_name%22%3A%22to%22%7D%2C%22value%22%3A%222023-03-10T20%3A00%3A00%2B05%3A30%22%7D&include_inner_details=user.zuid

Sample Request:

{{api-domain}}/crm/v4/settings/users_unavailability?filters=%7B%22comparator%22%3A%22equal%22%2C%22field%22%3A%7B%22api_name%22%3A%22to%22%7D%2C%22value%22%3A%222023-03-10T20%3A00%3A00%2B05%3A30%22%7D&include_inner_details=user.zuid

Response:

{
    "users_unavailability": [
        {
            "comments": "Unavailable during this time. Please schedule a call later.",
            "service": "CRM",
            "tp_event_id": null,
            "all_day": false,
            "from": "2023-02-28T19:00:00+05:30",
            "id": "3652397000011056010",
            "to": "2023-03-10T20:00:00+05:30",
            "title": null,
            "user": {
                "name": "Patricia Boyle",
                "id": "36xxx17",
                "zuid": "6xxxxx8"
            },
            "tp_calendar_id": null
        }
    ],
    "info": {
        "per_page": 200,
        "count": 1,
        "page": 1,
        "more_records": false
    }
}

We hope you found this post useful. Let us know your questions and feedback in the comment section, or write to us at support@zohocrm.com.

We will see you next week with another interesting post.
Cheers!

    Access your files securely from anywhere







                            Zoho Developer Community





                                                  Use cases

                                                  Make the most of Zoho Desk with the use cases.

                                                   
                                                    

                                                  eBooks

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

                                                   
                                                    

                                                  Videos

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

                                                   
                                                    

                                                  Webinar

                                                  Sign up for our webinars and learn the Zoho Desk basics, from customization to automation and more

                                                   
                                                    
                                                  • Desk Community Learning Series


                                                  • Meetups


                                                  • Ask the Experts


                                                  • Kbase


                                                  • Resources


                                                  • Glossary


                                                  • Desk Marketplace


                                                  • MVP Corner




                                                            • Sticky Posts

                                                            • Kaizen #197: Frequently Asked Questions on GraphQL APIs

                                                              🎊 Nearing 200th Kaizen Post – We want to hear from you! Do you have any questions, suggestions, or topics you would like us to cover in future posts? Your insights and suggestions help us shape future content and make this series better for everyone.
                                                            • Kaizen #198: Using Client Script for Custom Validation in Blueprint

                                                              Nearing 200th Kaizen Post – 1 More to the Big Two-Oh-Oh! Do you have any questions, suggestions, or topics you would like us to cover in future posts? Your insights and suggestions help us shape future content and make this series better for everyone.
                                                            • Celebrating 200 posts of Kaizen! Share your ideas for the milestone post

                                                              Hello Developers, We launched the Kaizen series in 2019 to share helpful content to support your Zoho CRM development journey. Staying true to its spirit—Kaizen Series: Continuous Improvement for Developer Experience—we've shared everything from FAQs
                                                            • Kaizen #193: Creating different fields in Zoho CRM through API

                                                              🎊 Nearing 200th Kaizen Post – We want to hear from you! Do you have any questions, suggestions, or topics you would like us to cover in future posts? Your insights and suggestions help us shape future content and make this series better for everyone.
                                                            • Client Script | Update - Introducing Commands in Client Script!

                                                              Have you ever wished you could trigger Client Script from contexts other than just the supported pages and events? Have you ever wanted to leverage the advantage of Client Script at your finger tip? Discover the power of Client Script - Commands! Commands


                                                            Manage your brands on social media



                                                                  Zoho TeamInbox Resources



                                                                      Zoho CRM Plus Resources

                                                                        Zoho Books Resources


                                                                          Zoho Subscriptions Resources

                                                                            Zoho Projects Resources


                                                                              Zoho Sprints Resources


                                                                                Qntrl Resources


                                                                                  Zoho Creator Resources



                                                                                      Zoho CRM Resources

                                                                                      • CRM Community Learning Series

                                                                                        CRM Community Learning Series


                                                                                      • Kaizen

                                                                                        Kaizen

                                                                                      • Functions

                                                                                        Functions

                                                                                      • Meetups

                                                                                        Meetups

                                                                                      • Kbase

                                                                                        Kbase

                                                                                      • Resources

                                                                                        Resources

                                                                                      • Digest

                                                                                        Digest

                                                                                      • CRM Marketplace

                                                                                        CRM Marketplace

                                                                                      • MVP Corner

                                                                                        MVP Corner







                                                                                          Design. Discuss. Deliver.

                                                                                          Create visually engaging stories with Zoho Show.

                                                                                          Get Started Now


                                                                                            Zoho Show Resources


                                                                                              Zoho Writer Writer

                                                                                              Get Started. Write Away!

                                                                                              Writer is a powerful online word processor, designed for collaborative work.

                                                                                                Zoho CRM コンテンツ








                                                                                                  Nederlandse Hulpbronnen


                                                                                                      ご検討中の方




                                                                                                            • Recent Topics

                                                                                                            • Automation Assistance for Zoho Form Integration and Workflow

                                                                                                              Hi, We are currently using a Zoho Form to send out our Global Credit Application and would like to automate the process further. Specifically, we’d like the ABN number submitted through the form to automatically populate the GST/VAT Number field in Zoho
                                                                                                            • COQL does not return queryable value if the result set is empty

                                                                                                              See linked video for running code illustration of the problem: https://workdrive.zohoexternal.com/external/d49bb40033b43b288d56fdf843095b7c65b28391d3ec5d09c854f416d853003d Moderation update: We are appending the comment that was removed, to add context
                                                                                                            • Zoho CRMでの商談の管理のしかたについて初歩的な質問です。

                                                                                                              先月からZoho CRMを試験的に導入して運用しています。 商談の管理(運用?)の仕方について教えてください。 商談の数が増えてくると、ダッシュボードの「ステージ別進捗状況」にどんどん過去の商談が蓄積されてくると思うのですが、 現在動きのあるものを中心に確認したくなる気がします。 そのあたりについては、どのように運用が一般的なのでしょうか? アドバイスいただけるととてもありがたいです。 よろしくお願いします。
                                                                                                            • Composite Items & Purchase Orders

                                                                                                              The Composite Item is great way to bundle different products and services into a single line and sell it as a single line item in Estimates, Sales Orders and Invoices. However, on the other side - i,e,. Purchasing - this item creates quite a bit of a
                                                                                                            • using custom function is it possible to update the created by field in Zoho Crm custom module

                                                                                                              using custom function is it possible to update the created by field in Zoho Crm custom module
                                                                                                            • Slow Sloww Slowwww Responses

                                                                                                              Good day, Has anyone been experiencing slow responses from support? Since Thursday I migrated my Whats app to Sales Iq and I had to synch with Social to get the otp they were sending. Apparently What's app can't be automatically added so I reached out
                                                                                                            • You have exceeded the maximum number of attempts for this action. Please retry doing the same in 30 minutes.

                                                                                                              When one of Zoho Books user tries to select a vendor, recording a new bill, these message appears: You have exceeded the maximum number of attempts for this action. Please retry doing the same in 30 minutes. Other user, at the same time, but different
                                                                                                            • Enable Conversation Context Retention for SalesIQ Answer Bots

                                                                                                              Hello Zoho SalesIQ Team, We hope you are doing well. We have noticed that SalesIQ bots currently fail to maintain conversation context in Hebrew. For example, when we follow up on a previous answer or ask for clarification in Hebrew, the bot either provides
                                                                                                            • Automatic Hebrew Small Talk Setup Without Duplicate Term Errors & Manual Configuration

                                                                                                              Dear Zoho SalesIQ Team, Greetings, We would like to request an enhancement to the Small Talk feature in Zoho SalesIQ, specifically for Hebrew language support. Current Challenge: When setting up Small Talk for Hebrew, we encounter multiple issues: Simple
                                                                                                            • Should I Add Leads in Bigin?

                                                                                                              ok, first off I'm new here. I just started using Bigin. I'm debating if it's appropriate to enter leads. by leads I mean a list of contacts that I have not yet reached out to...it's a cold calling list.  if I enter them I can track them (I understand
                                                                                                            • Zoho Books - Perform a validation check before an invoice is marked as sent or sent

                                                                                                              Allow the validation rules to apply to button actions. For example: an invoice could not be sent or marked as sent if it has an empty value in a custom field. (The field could remain blank while it is being worked on.)
                                                                                                            • Flow error "given url is wrong"

                                                                                                              when I setup a flow to update a task status, I get an error when it runs that says "given url is wrong."
                                                                                                            • Upgrade Zoho Desk Agent-Side Answer Bot to GenAI

                                                                                                              Hello Zoho Desk Team, We hope you're doing well. Following the recent announcements and rollout of the GenAI-based Answer Bot in Zoho SalesIQ (Nova '25), we’d like to formally request a similar upgrade for the Answer Bot used by agents inside Zoho Desk.
                                                                                                            • Bigin Android app update: Email filters enhancement, change owner for related records.

                                                                                                              Hello, everyone! In the most recent Bigin Android app update, we have introduced additional email filters and an option to change the owner of related records. Email filters: We have now brought in support for 'All Emails' and 'Added from Widgets' filter
                                                                                                            • How can I get all conversations and comments of a Zoho Desk ticket using ZOHODESK

                                                                                                              Hi everyone, Currently, I am developing a Zoho Desk extension, and I am following the guide available at https://www.zoho.com/desk/extensions/guide/#ticket-object. While working with Zoho Desk, I have noticed that I can only retrieve the general information
                                                                                                            • AI & Zoho Recruit

                                                                                                              Hello, I guess we all are using AI in our personal and professional lives. Now, let's imagine. Recruitment is just a succession of stages and steps. For which step would you like to see AI implemented into Zoho Recruit ? I'll start : - Automatic translation
                                                                                                            • Workdrive and ChatGPT Team Synced Connectors

                                                                                                              Hi, we want to be able to integrate Zoho Workdrive with OpenAI’s ChatGPT Team plan. Google Drive and OneDrive both offer this, zoho please catch up asap. We dont want to have to put our company files in google drive, we want to allow chatgpt Team edition
                                                                                                            • widget url 404'ing

                                                                                                              I'm creating a widget for the first time. When I grab the url from the base url section of the widget builder and append /widget.html it 404's Just wrote a very basic test. I have a folder structure app.zip - widget.html --js/app.js /widget.html <!DOCTYPE
                                                                                                            • Unable to Edit Pick-List Items in Custom Project Field(s)

                                                                                                              I can edit most fields normally, but if I try to edit - in any way - a Pick List field, I just get this error: To be perfectly clear, I'm trying to edit an existing Pick List field (adding or removing items), not adding a new instance. If I rename it,
                                                                                                            • How to display results from zoho.crm.searchRecords in message window

                                                                                                              Hello, I've created a custom function which is linked to a custom button which pulls a date from our contacts module and searches a date field in our quotes module and returns all records matching the date. My issue is, how to I get this to display the
                                                                                                            • Domain Transfer

                                                                                                              Hello there! I wanted to know if I can transfer my domain from Zoho to other hosting providers or use a different hosting provider instead of zoho's services.
                                                                                                            • Select CRM Custom Module in Zoho Creator

                                                                                                              I have a custom module added in Zoho CRM that I would like to link in Zoho creator.  When I add the Zoho CRM field it does not show the new module.  Is this possible?  Do i need to change something in CRM to make it accesible in Creator?
                                                                                                            • New User - Opening Stock Aging Report

                                                                                                              I am setting up new client and am entering Opening Stock - created items and entered quantity/price details. Now the aging report is showing all the opening stock as new. How do I enter the Purchase Dates of these items so that I get accurate Inventory
                                                                                                            • Bulk Receive Multiple Purchase Orders

                                                                                                              Is there a feature or function that will allow you to bulk receive issued purchase orders? I have about 100 that need to be received from 5 years ago.
                                                                                                            • Manual Invoice

                                                                                                              How to create a Manual invoice, I need to enter Amount directly instead of (qty*Rate). our company is a service sector
                                                                                                            • Effective Inbox Organization: Folders vs Tags in Zoho Mail?

                                                                                                              I'm exploring the best ways to organize a busy inbox, especially when managing multiple clients or project using Zoho Mail. I’d love to know what works best for others: 1. Do you prefer **folders** (possibly with sub-folders) for each client or project?
                                                                                                            • Merging contacts and or accounts

                                                                                                              Hello, In a prior CRM we were able to merge contacts and or accounts.  We have turned on the function to stop multiple contacts with the same email, so we can prevent multiple contacts from happening, however, we now have multiple contacts that have the
                                                                                                            • Capture Reason for absence next to Campaign Member Status. Is there a reasonable workaround?

                                                                                                              I've reviewed the topics I could find to do with this but still couldn't find anything that satisfies our requirements: We would like to track a *reason* (picklist or text, doesn't matter which) why a Campaign Member (Lead or Contact associated with a
                                                                                                            • Zoho Learning Management System - Certificate Upload by Employees

                                                                                                              We are planning to enroll employees in courses which are hosted by coursera or similar sites. I want to share the links of those courses and also want employees to upload their completion certificate once they are done. Is this function possible in
                                                                                                            • Add RTL and Hebrew Support for Candidate Portal (and Other Zoho Recruit Portals)

                                                                                                              Dear Zoho Recruit Team, I hope you're doing well. We would like to request the ability to set the Candidate Portal to be Right-to-Left (RTL) and in Hebrew, similar to the existing functionality for the Career Site. Currently, when we set the Career Site
                                                                                                            • Button or Links order

                                                                                                              Is there a way to re-order the buttons or links that are created?
                                                                                                            • Adding Multiple Products (Package) to a Quote

                                                                                                              I've searched the forums and found several people asking this question, but never found an answer. Is ti possible to add multiple products to a quote at once, like a package deal? This seems like a very basic function of a CRM that does quotes but I can't
                                                                                                            • 'Pin' notes, so that specific ones are always visible at the top of the 'notes' tab.

                                                                                                              It doesn't appear Bigin has the functionality to 'pin' a note to then have it always show at the top of the notes tab section of a record. Often times we have a large number of records, but key information we may want to have easily visible to all at
                                                                                                            • Request for Subform Support in Zoho CRM Webforms

                                                                                                              Hi Team, I hope you're doing well. I would like to bring to your attention that currently, Zoho CRM Webforms do not support Subforms, which limits our ability to send forms that mirror the actual structure used within Zoho CRM. This feature is extremely
                                                                                                            • Formatting Mailing Labels

                                                                                                              I want to use the "Print Mailing Labels" function on the drop down list, but I am not seeing a way to change the formatting on the mailing labels. At the moment, the information that appears on the mailing labels ARE NOT mailing addresses, but random
                                                                                                            • Maxima Address on FSM Customer

                                                                                                              Im trying to add probably 50 customers from one company but couldn't make it since it has limit..how do i add the limit?
                                                                                                            • How to Track Inventory Usage from Zoho FSM to Zoho Inventory?

                                                                                                              Hi everyone, We’re currently working on integrating Zoho FSM with Zoho Inventory, and we’ve encountered a challenge we’re hoping the community can help us understand better. Here’s the context: When we create a Work Order in Zoho FSM that involves parts
                                                                                                            • View subform entries without viewing a record in Zoho CRM | Kiosk Studio Session #8

                                                                                                              In a nutshell Have you ever wanted to take a quick peek at a record's subform? Examples might be invoiced items in an invoice, ordered items in a sales order, or purchased items in a purchase order. Let's say you're viewing your list of invoices in Zoho
                                                                                                            • How to Create a YTD vs Last YTD Comparison Report in Zoho Analytics?

                                                                                                              Hi everyone, I'm trying to build a report that compares Year-to-Date (YTD) metrics from this year to last year. I’m struggling to get accurate results using custom formulas or aggregate functions. Has anyone successfully created a YTD vs LYTD comparison
                                                                                                            • Transforma tu Inventario: Control Inteligente y Funciones Clave en Zoho Inventory (Spanish Webinar)

                                                                                                              ¿Tu empresa necesita mayor trazabilidad y control en almacenes? Conoce cómo gestionar tu inventario con eficiencia y automatización... ¡y descubre las sorpresas que trae Zoho Analytics! Participa en nuestro webinar gratuito en español, este 19 de agosto
                                                                                                            • Next Page