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




                                                  • Desk Community Learning Series


                                                  • Digest


                                                  • Functions


                                                  • Meetups


                                                  • Kbase


                                                  • Resources


                                                  • Glossary


                                                  • Desk Marketplace


                                                  • MVP Corner


                                                  • Word of the Day


                                                  • Ask the Experts



                                                            • Sticky Posts

                                                            • Kaizen #222 - Client Script Support for Notes Related List

                                                              Hello everyone! Welcome to another week of Kaizen. The final Kaizen post of the year 2025 is here! With the new Client Script support for the Notes Related List, you can validate, enrich, and manage notes across modules. In this post, we’ll explore how
                                                            • Kaizen #217 - Actions APIs : Tasks

                                                              Welcome to another week of Kaizen! In last week's post we discussed Email Notifications APIs which act as the link between your Workflow automations and you. We have discussed how Zylker Cloud Services uses Email Notifications API in their custom dashboard.
                                                            • Kaizen #216 - Actions APIs : Email Notifications

                                                              Welcome to another week of Kaizen! For the last three weeks, we have been discussing Zylker's workflows. We successfully updated a dormant workflow, built a new one from the ground up and more. But our work is not finished—these automated processes are
                                                            • Kaizen #152 - Client Script Support for the new Canvas Record Forms

                                                              Hello everyone! Have you ever wanted to trigger actions on click of a canvas button, icon, or text mandatory forms in Create/Edit and Clone Pages? Have you ever wanted to control how elements behave on the new Canvas Record Forms? This can be achieved
                                                            • Kaizen #142: How to Navigate to Another Page in Zoho CRM using Client Script

                                                              Hello everyone! Welcome back to another exciting Kaizen post. In this post, let us see how you can you navigate to different Pages using Client Script. In this Kaizen post, Need to Navigate to different Pages Client Script ZDKs related to navigation A.


                                                            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

                                                                                              Get Started. Write Away!

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

                                                                                                Zoho CRM コンテンツ



                                                                                                  Nederlandse Hulpbronnen


                                                                                                      ご検討中の方




                                                                                                              • Recent Topics

                                                                                                              • "Spreadsheet Mode" for Fast Bulk Edits

                                                                                                                One of the challenges with using Zoho Inventory is when bulk edits need to be done via the UI, and each value that needs to be changed is different. A very common use case here is price changes. Often, a price increase will need to be implemented, and
                                                                                                              • Email Notifications not pushing through

                                                                                                                Hi, Notifications from CRM are not reaching my users as they trigger.  We have several workflow triggers set up that send emails to staff as well as the notifications users get when a task is created for them or a user is tagged in the notes.  For the past 6 days these haven't been coming through in real time, instead users are receiving 30-40 notifications in one push several hours later.  This is beginning to impact our daily usage of CRM and is having a negative effect on our productivity because
                                                                                                              • Ticket layout based on field or contact

                                                                                                                Hi! I want to support the following use-case: we are delivering custom IT solutions to different accounts we have, thus our ticket layouts, fields and languages (priority, status field values should be Hungarian) will be different. How should I setup
                                                                                                              • Add specific field value to URL

                                                                                                                Hi Everyone. I have the following code which is set to run from a subform when the user selects a value from a lookup field "Plant_Key" the URL opens a report but i want the report to be filtered on the matching field/value. so in the report there is
                                                                                                              • Syncing Bills in Zoho Books to Zoho CRM

                                                                                                                Is there any way to sync the Bills in Zoho Books in Zoho CRM
                                                                                                              • Desk DMARC forwarding failure for some senders

                                                                                                                I am not receiving important emails into Desk, because of DMARC errors. Here's what's happening: 1. email is sent from customer e.g. john@doe.com, to my email address, e.g info@acme.com 2. email is delivered successfully to info@acme.com (a shared inbox
                                                                                                              • SAML in Zoho One vs Zoho Accounts

                                                                                                                What is the difference between setting up SAML in Zoho Accounts: https://help.zoho.com/portal/en/kb/accounts/manage-your-organization/saml/articles/configure-saml-in-zoho-accounts ... vs SAML in Zoho One?: https://help.zoho.com/portal/en/kb/one/admin-guide/custom-authentication/setting-up-custom-authentication-with-popular-idps/articles/zohoone-customauthentication-azure
                                                                                                              • How do I change the order of fields in the new Task screen?

                                                                                                                I have gone into the Task module layout, and moving the fields around does not seem to move them in the Create Task screen. Screenshot below. I have a field (Description) that we want to use frequently, but it is inconveniently placed within the More
                                                                                                              • Zoho Inventory. Preventing Negative Stock in Sales Orders – Best Practices?

                                                                                                                Dear Zoho Inventory Community, We’re a small business using Zoho Inventory with a team of sales managers. Unfortunately, some employees occasionally overlook stock levels during order processing, leading to negative inventory issues. Is there a way to
                                                                                                              • CRM gets location smart with the all new Map View: visualize records, locate records within any radius, and more

                                                                                                                Hello all, We've introduced a new way to work with location data in Zoho CRM: the Map View. Instead of scrolling through endless lists, your records now appear as pins on a map. Built on top of the all-new address field and powered by Mappls (MapMyIndia),
                                                                                                              • Deactivated Zoho One account can sign in

                                                                                                                I am concerned by the fact that deactivated users in Zoho One have the ability to sign in even after their account has been deactivated (not deleted). these inactive identities have no access to individual Zoho apps or data. based on my experience they
                                                                                                              • How can I reset the password for a user in Zoho Projects

                                                                                                                We need to reset the password for a user in Zoho Projects. I am the admin portal owner and there was nothing to be found to do this. very confusing.
                                                                                                              • No funcionan correctamente el calculo de las horas laborales para informe de tickets

                                                                                                                Hola, estoy intentando sacar estadísticas de tiempo de primera respuesta y resolución en horario laboral de mis tickets, pero el calculo de horas en horario laboral no funciona correctamente cree los horarios con los feriados : Ajusté los acuerdos de
                                                                                                              • How can I add a comment to an existing ticket via API?

                                                                                                                I need to add comments/notes to the history of an existing ticket using the API without overwriting the original ticket description. Thanks!
                                                                                                              • Notification to customers when I use a Zoho function

                                                                                                                Hi all, I tried searching the community but couldn't find anything about it. I noticed that the customer receives the notification of reopening the old ticket but does not receive the notification of opening a new ticket when I use the function: "separate
                                                                                                              • Internal Error When Accessing Team Inbox.

                                                                                                                All our users are seeing this error in teaminbox. Because its a critical tool kindly resolve this issue ASAP.
                                                                                                              • Marketer's Space: Proven tips to improve open rates – Part III

                                                                                                                Hello Marketers! Welcome back to another post in Marketer's Space! This is the final post in the "open rate series". In the first and second parts, we discussed topics ranging from sender domains to pre-headers—but we're not done yet. A few more important
                                                                                                              • MCP no longer works with Claude

                                                                                                                Anyone else notice Zoho MCP no longer works with Claude? I'm unable to turn this on in the claude chat. When I try to toggle it on, it just does nothing at all. I've tried in incognito, new browsers, etc. - nothing seems to work.
                                                                                                              • Change Number Field to Decimal Field

                                                                                                                Hi, It would be nice to be able to change the field type without having to delete it and create a new one, messing up the database and history. Thanks Dan
                                                                                                              • Allow Text within a Formula

                                                                                                                Hi, I would like to be able to use this for others things like taking an existing Date Field and copying its value, so by entering getDay(Date)&"-"&getMonth(Date)&"-"&getYear(Date) it results in 01-02-2026. And then when the Date is changed so is this
                                                                                                              • Zoho Social - Feature Request - Reviewer Role

                                                                                                                Hi Social Team, I've come across this with a couple of clients, where they need a role which can review and comment on posts but who has no access to create content. This is a kind of reviewer role. They just need to be able to see what content is scheduled
                                                                                                              • Zoho Books/Inventory - Update Marketplace Sales Order via API

                                                                                                                Hi everyone, Does anyone know if there is a way to update Sales Orders created from a marketplace intigration (Shopify in this case) via API? I'm trying to cover a scenario where an order is changed on the Shopify end and the changes must be reflected
                                                                                                              • Zoho Inventory / Finance Suite - Add feature to prevent duplicate values in Item Unit field

                                                                                                                I've noticed that a client has 2 values the same in the Unit field on edit/create Items. This surprised me as why would you have 2 units with the same name. Please consider adding a feature which prevents this as it seems to serve no purpose.
                                                                                                              • Zoho CRM for Everyone's NextGen UI Gets an Upgrade

                                                                                                                Hello Everyone We've made improvements to Zoho CRM for Everyone's Nextgen UI. These changes are the result of valuable feedback from you where we’ve focused on improving usability, providing wider screen space, and making navigation smoother so everything
                                                                                                              • Kaizen #224 - Quote-driven Deal Reconciliation Using Zoho CRM Functions and Automation

                                                                                                                Hello everyone! Welcome back to another instalment in the Kaizen series. This post covers quote-driven deal reconciliation, emphasizing Functions and Automation to address practical sales challenges. Business Challenge Sales organizations often mark deals
                                                                                                              • Dependent / Dynamic DropDown in ZohoSheets

                                                                                                                Has anyone figured out a way to create a Dropdown, the values of which is dependent on Values entered in the other cell ?
                                                                                                              • Zoho Inventory - Composite Items - Assembly - Single Line Item Quantity of One

                                                                                                                Hi Zoho Inventory Team, Please consider relaxing the system rules which prevent an assembly items from consisting of a single line item and outputting a quantity of 1. A client I'm currently working with sells cosmetics and offers testers of their products
                                                                                                              • Directly Edit, Filter, and Sort Subforms on the Details Page

                                                                                                                Hello everyone, As you know, subforms allow you to associate multiple line items with a single record, greatly enhancing your data organization. For example, a sales order subform neatly lists all products, their quantities, amounts, and other relevant
                                                                                                              • BARCODE PICKLIST

                                                                                                                Hello! Does anyone know how the Picklist module works? I tried scanning the barcode using the UPC and EAN codes I added to the item, but it doesn’t work. Which barcode format does this module use for scanning?
                                                                                                              • Zoho Inventory - Allow Update of Marketplace Generated Sales Orders via API

                                                                                                                Hi Inventory Team, I was recently asked by a client to create an automation which updated a Zoho Inventory Sales Order if a Shopify Order was updated. I have created the script but I found that the request is blocked as the Sales Order was generated by
                                                                                                              • How do I create an update to the Cost Price from landed costs?

                                                                                                                Hi fellow Zoho Inventory battlers, I am new to Zoho inventory and was completely baffled to find that the cost price of products does not update when a new purchase order is received. The cost price is just made up numbers I start with when the product
                                                                                                              • Manage control over Microsoft Office 365 integrations with profile-based sync permissions

                                                                                                                Greetings all, Previously, all users in Zoho CRM had access to enable Microsoft integrations (Calendar, Contacts, and Tasks) in their accounts, regardless of their profile type. Users with administrator profiles can now manage profile-based permissions
                                                                                                              • Zoho OAuth Connector Deprecation and Its Impact on Zoho Desk

                                                                                                                Hello everyone, Zoho believes in continuously refining its integrations to uphold the highest standards of security, reliability, and compliance. As part of this ongoing improvement, the Zoho OAuth default connector will be deprecated for all Zoho services
                                                                                                              • VoC in Zoho CRM is now data savvy: Explore response drilldown, summary components and participation in CRM criteria

                                                                                                                VoC has all the goods when it comes to customer intelligence—which is why we're constantly enhancing it. We recently added the following: A customer drilldown component that shows you the list of prospects and customers behind a chart's attribute Expanded
                                                                                                              • How do I bulk archive my projects in ZOHO projects

                                                                                                                Hi, I want to archive 50 Projects in one go. Can you please help me out , How can I do this? Thanks kapil
                                                                                                              • Error 0x800CCC0F Outlook

                                                                                                                Hello, i cannot send or receive email in outlook. can you please help. 'Sending' reported error (0x800CCC0F) : 'The connection to the server was interrupted. If this problem continues, contact your server administrator or Internet service provider (ISP).'
                                                                                                              • Passing the CRM

                                                                                                                Hi, I am hoping someone can help. I have a zoho form that has a CRM lookup field. I was hoping to send this to my publicly to clients via a text message and the form then attaches the signed form back to the custom module. This work absolutely fine when
                                                                                                              • Can I add Conditional merge tags on my Templates?

                                                                                                                Hi I was wondering if I can use Conditional Mail Merge tags inside my Email templates/Quotes etc within the CRM? In spanish and in our business we use gender and academic degree salutations , ie: Dr., Dra., Sr., Srta., so the beginning of an email / letter
                                                                                                              • Zoho vault instal on windows

                                                                                                                I am trying to use Zoho Vault Desktop for Windows, but I am unable to complete the sign-in process. Problem description After logging in to my Zoho account and clicking Accept on the authorization page, nothing happens. The application does not proceed
                                                                                                              • Zoho Browser??

                                                                                                                hai guys, this sounds awkward but can v get a ZOHO BROWSER same as zoho writer, etc. where i can browse websites @ home and continue browsing the same websites @ my office, as v have the option in Firefox, once i save and close the browser and again when i open it i will be getting the same sites. If u people r not clear with my explanation, plz let me know. Thanks, Sandeep  
                                                                                                              • Next Page