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

                                                                                                            • Agent Collision Missing from Mobile App

                                                                                                              Please add Agent Collision capabilities to the mobile app.
                                                                                                            • Zia Sentiment and Functionality on Mobile

                                                                                                              Please add Zia sentiment and generative responses to the mobile app. It would be nice to see the ticket sentiment and generate a response back to a user using Zia on my iPhone
                                                                                                            • View Account Attachments on iOS

                                                                                                              Please allow us to view account attachments on the mobile iOS app!
                                                                                                            • How do I run a PnL by Sales Person?

                                                                                                              I am trying to run a PnL by sales person but am not seeing the option do so. All I need to know (per salesperson) is revenue, cost of goods, gross profit.
                                                                                                            • View Contracts and Support Plans on Mobile

                                                                                                              We would like to be able to see contracts and support plans from the mobile app on iOS!
                                                                                                            • Why is Zoho Meeting quality so poor?

                                                                                                              I've just moved from Office 365 to Zoho Workplace and have been generally really positive about the new platform -- nicely integrated, nice GUI, good and easy-to-understand control and customisation, and at a reasonable price. However, what is going on
                                                                                                            • App like Miro

                                                                                                              Hi all, is there a way to have a interactive whiteboard like in Miro? We want to visualize our processes and workflows in an easy way.
                                                                                                            • Loan repayment Entry

                                                                                                              While receiving loan, i does following steps in My Zoho books. 1. Create "Loan & Advance " Account as Parent Account under Long Term Liabilities. 2. Create another account For Example "Mr. ABC's Loan as Child account under the parent account. Now: In
                                                                                                            • Quotes module send email reverted back into 2022??

                                                                                                              Our Zoho CRM PLUS quotes, sales orders, invoice modules is showing us an email composer from 2022. We cannot send emails and its been a real pain. I tried clicking the new version over there but it doesnt seem to do anything. Any help is welcome. th
                                                                                                            • Workflow Condition - how do check that a date / time value is in the past?

                                                                                                              Hello, I'm got a workflow that runs a function when records reach their 'Effective Date / Time', but sometimes records are created after the 'Effective Date / Time' so I have another workflow that checks for records which needs to be processed immediately.
                                                                                                            • Pre filling SignForm field values by URL field alias's in Zoho Sign

                                                                                                              Hi, Does anyone know if it's possible to pre fill the field values of the SignForm by using field alias's like you can in Zoho forms? To be more specific, I want to be able to change the SignForm URL to include some information like this: Before : https://sign.zoho.eu/signform?form_link=234b4d535f495623920c288fc8538cb9e6db03bbfd44499b63f3e5c48daf78f44bc47f333e2f5072cc1ee74b7332fe18b25c93fab10cb6243278d49c67eacbf30bbe5b6e1cc8c6b2#/
                                                                                                            • How to Split Payout in Zoho Books (Without Using Journal?)

                                                                                                              Hi, I'm trying to properly record payouts in Zoho Books. The issue is that each payout is a combination of sales and expenses (fees). When I try to categorise the payout transaction from the Banking tab, I can only split the transaction using income-type
                                                                                                            • Payment Schedule

                                                                                                              Please add the ability to create a payment schedule. The other options, like retainer invoices or two invoices, do not work for the customer.  We invoice a client and need to be able to show them everything they owe in one invoice, and when each payment
                                                                                                            • Google Recaptcha V3

                                                                                                              Hi, Why, years later now, are we still waiting for Zoho Forms to incorporate Google Recaptcha V3 into it's systems? Come on Zoho this has been an ongoing issue for over a year now!! It should be a priority.
                                                                                                            • Which pricing system do you think would work best for us?

                                                                                                              Imagine we’re selling strictly wholesale. We’d rather not publish unit prices; instead, we quote customers case-by-case. To spur larger orders, we’re considering a transparent discount ladder—say: $0 – $999: 0 % $1,000 – $1,999: 5 % $2,000 – $4,999: 10
                                                                                                            • Add Support for Google reCAPTCHA v3 in Zoho Forms

                                                                                                              Hello Zoho Forms Team, We appreciate the security measures currently available in Zoho Forms, including Zoho CAPTCHA, Google reCAPTCHA v2 (checkbox), and reCAPTCHA v2 (Invisible). However, we would like to request the addition of support for Google reCAPTCHA
                                                                                                            • Can't Remove Payment Gateway

                                                                                                              I am getting the error "Settings cannot be cleared as some of the transactions are still in progress." when trying to remove the PayGate payment gateway which I was unable to get working. I am now using paystack and I want to remove Paygate.
                                                                                                            • Sync specific Zoho Inventory Warehouses to Zoho Commerce

                                                                                                              As said in the title, we would want to only sync stock from one warehouse of Zoho Inventory to the Zoho Commerce item stock. We have a 2 warehouses in different countries and the way that Zoho Commerce works (It takes stock from ALL WAREHOUSES EVERYWHERE
                                                                                                            • Weekly Tips : Automatically clean clutter with Junk cleanup interval

                                                                                                              If you regularly receive many unwanted or spam emails, your Spam folder can quickly fill up and start taking up valuable storage space in your Zoho Mail account. Instead of manually clearing it every few days, you might find it helpful to enable automatic
                                                                                                            • Any solution for getting portal users list in deluge or in widget

                                                                                                              Hi Team, Has anyone able to find the solution to get portal users list in deluge or in zoho creator widgets? Thanks, Payal
                                                                                                            • The Grid is here!

                                                                                                              Hey Zoho Forms Community! 👋 We’re thrilled to announce the launch of a feature that’s been on your wishlist for a while: Grids What is Grids? Grids let you place form fields side by side in multiple columns to create a more concise and organized form
                                                                                                            • Steuerberater der Zoho benutzt in Deutschland

                                                                                                              I write in English because the issue is related to German regulations. Wir sind ein Unternehmen, welches aktuell keine Pflicht zur doppelten Buchführung hat. Aktuell bucht unser Steuerberater jeden Beleg, auch unsere Auslagen. Wir würden dies gerne selbst
                                                                                                            • GraphQL in new Send Webhooks feature

                                                                                                              Hello, is it possible to use GraphQL apis in the new Send Webhooks feature?
                                                                                                            • # 2 Why do we need a billing system when accounting covers billing?

                                                                                                              In today's evolving financial tech stack, businesses use a mix of tools to manage their day-to-day operations, from invoicing to full-fledged accounting. While accounting platforms typically come with built-in invoicing features, specialized billing systems
                                                                                                            • How to insert an Excel/Zoho Sheet table in a chat?

                                                                                                              Hello, is there a way to paste an excel/zoho sheet table to a conversation without loosing table lines. I tried to paste a piece of a table and all the columns and rows were gone. How to easily paste a table without a need of sending a file? Katarzy
                                                                                                            • Mass Update Application Status

                                                                                                              How to update application statuses of Multiple Applications at once? Is that possible? If not then why please consider adding it It can save hours of manual work Thats the only Option I see
                                                                                                            • Free webinar: Streamlining customer service paperwork with the Zoho Sign extension for Zoho Desk

                                                                                                              Hi there! Wondering how to bridge the gap between digitized customer service and business paperwork? Attend our free webinar to learn how you can do this by connecting Zoho Sign, our digital signature app, with Zoho Desk, our online customer service help
                                                                                                            • Mail Search Not Working

                                                                                                              Hello, Mail search is not working at all. I've tried Chrome and Mozilla. I can try and search for an exact term, or even an email that is 1st in my email list. All search does is sit and spin, or it comes up with no results. I've also tried it on my android
                                                                                                            • Cannot Send Email to a Gmail Account

                                                                                                              Hello, I have a zoho-hosted email account, alex@chirochannelnetwork.com that has trouble sending to gmail accounts.  But not all gmail accounts, only some of them. I've tried to figure this out with clients, and they don't appear to be going into their
                                                                                                            • Unblock ME

                                                                                                              info@pentekykloi.gr Unable to send message;Reason:554 5.1.8 Email Outgoing Blocked. Learn more. I purchase additional storage
                                                                                                            • The Social Wall: July 2025

                                                                                                              Hello everyone! July has brought some exciting new updates to Zoho Social. From powerful enhancements in the Social Toolkit to new capabilities in the mobile app, we’ve packed this month with features designed to help you level up your social media presence.
                                                                                                            • Cannot Print Landscape with Zoho Sheet

                                                                                                              I am noticing that when using the Zoho Sheet desktop for Mac, that even when selecting landscape as the print option, once you choose "Print", a second system dialog opens that automatically makes the view portrait again, and does not allow printing in
                                                                                                            • Power of Automation : Enhancing custom date field calculations by excluding Weekends and Holidays

                                                                                                              Hello Everyone, A Custom function is a user-written set of code to achieve a specific requirement. Set the required conditions needed as when to trigger using the Workflow rules (be it Tasks / Project) and associate the custom function to it. Requirement:
                                                                                                            • Stock count by bin location

                                                                                                              Is there a configuration to make a stock count by bin or area and not by product. these is useful to manage count by area Regards
                                                                                                            • Temporary Outage in Zoho Cliq Affecting US Users – July 23, 2025

                                                                                                              We experienced a service disruption in Zoho Cliq that impacted core functionality for users in the US region. The issue occurred between Jul 23, 2025, 06:54:00 PM IST and 07:13:13 PM IST, lasting approximately 19 minutes. To restore service stability,
                                                                                                            • portal.assignUserInProfile - Não esta adicionando

                                                                                                              Estou encontrando problema com este comando portal.assignUserInProfile Não esta incluindo o usuário no portal Alguém pode me dizer o que pode ser thisapp.portal.assignUserInProfile("teste@gmail.com","Customer");
                                                                                                            • CRM emails vs Campaigns

                                                                                                              Please help me understand this. I am having a difficult understanding of "Campaigns" sent through CRM (real emails) or Zoho One (blast "potentially junk" emails) This is what I currently think emails sent via CRM are "real" emails sent through linked real personal email accounts and therefore are more likely to get delivered.  We use this for critical updates for our "Approved " accounts and certain other preferred statuses emails via Campaigns are sent through the Zoho server (like MailChimp, Campaign
                                                                                                            • Setting up property management in Zoho Books

                                                                                                              Hi, I run a property management business that manages property complexes. There are multiple owners, some owning more than one property on the same complex. My role is to manage the fees they pay for maintenance of common areas, such as the swimming pool
                                                                                                            • Reverse proxy

                                                                                                              We have a web application in the creator platform. When I launch a particular DNS, I would like that DNS to redirect to the web page of the application in creator app. Has anyone achieved it and if yes, please share how to do it.
                                                                                                            • Still client need to download .exe?

                                                                                                              Hello, the client for use zoho assist need everytime download .exe file and launch it?
                                                                                                            • Next Page