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" } } ]}
{
"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
New to Zoho Recruit?
Zoho Developer Community
New to Zoho LandingPage?
Zoho LandingPage Resources
New to Zoho Survey?
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho Marketing Plus?
Everything you need to run your marketing
New to Zoho Marketing Plus?
Everything you need to run your marketing
New to Bigin?
Topic Participants
Shylaja S
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 FAQsKaizen #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
New to Zoho TeamInbox?
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
Design. Discuss. Deliver.
Zoho Show Resources
Get Started. Write Away!
Writer is a powerful online word processor, designed for collaborative work.
Zoho CRM コンテンツ
-
オンラインヘルプ
-
Webセミナー
-
機能活用動画
-
よくある質問
-
Ebook
-
-
Zoho Campaigns
- Zoho サービスのWebセミナー
その他のサービス コンテンツ
Nederlandse Hulpbronnen
ご検討中の方
Recent Topics
Collect in-app feedback with richer context and granular insights
Hello, Apptics community! From GenAI chatbots to one-tap checkouts, user experience standards keep rising—yet 96% of unhappy users never explain what went wrong; they simply leave. Introducing in-app feedback 2.0 banner In-app feedback 2.0 is here toTemporary restiction
My account says You have been temporarily restricted from publishing jobs from Zoho Recruit.Click here to request a one-time approval to publish your jobs and when I go to click it shows error. Kindly assist.Help with Quote template for peer review
We are wanting to do peer review of quotes/proposals, however the quote templates dont have product cost, profit margins, etc. It is difficult for a manager to approve a quote without ensuring nothing is going out at improper margins, etc. I have notIndia Tech Support
Is there no phone tech support number for India? And no chat facility either?How many AR fields We can add in a form?
I want to add at least 10-15 AR fields in a form. I just want to know is there any limit on the AR fields or do I need to pay extra money for using 10-15 AR fields. Thanks in advance.Agent working hours
Hi, I know it is possible to set company business hours but is it possible so that agents can have different ones? I.e. some agents cover later hours on specific weeks - can these be set so those agents that are "working" get notified about tickets etc.Disallow CLOSE if tags field is empty
I want to introduce a mandatory condition that NEW tickets (not prior closed tickets) cannot enter the CLOSED state without first having an entry in the tags field. Is there a way I can do this?Central de Ajuda - Restringir visualização de tickets
Estou tentando configurar o Zoho Desk para que determinados usuários dentro de uma mesma conta consigam visualizar apenas os tickets criados por usuários específicos dessa conta — e não todos os tickets ou apenas os seus próprios. Até onde sei, existeBusiness Hours with lunch break
Our business hours are: mon - fri 08:30 - 13:00, 15:00 - 18:30. How can I handle the lunch break? If I use 8:30 - 18:30 it obviously breaks SLA. ThanksDefault/Private Departments in Zoho Desk
1) How does one configure a department to be private? 2) Also, how does one change the default department? 1) On the list of my company's Zoho Departments, I see that we have a default department, but I am unable to choose which department should be default. 2) From the Zoho documentation I see that in order to create a private department, one should uncheck "Display in customer portal" on the Add Department screen. However, is there a way to change this setting after the department has been created?Ask the Experts 21: Power up your support game with Zoho Desk Automation
" In every business, there are tasks to automate, Zoho Desk helps with features that integrate Assignments to manage tickets and teams to align,Macros for quick actions and workflows to streamline Contracts and schedules to hold things tight, Plans runIf leads are assigned to a person before 4:00 PM and the stage is "Fresh Lead", then an email should be triggered at 4:00 PM to all assigned users. If leads are assigned after 4:00 PM and the stage is
If leads are assigned to a person before 4:00 PM and the stage is "Fresh Lead", then an email should be triggered at 4:00 PM to all assigned users. If leads are assigned after 4:00 PM and the stage is "Fresh Lead", then the email should be triggered theMultiselect lookup in subform
It would be SO SO useful if subforms could support a multiselect look up field! Is this in the works??Tasks as calendar events? What about a way to verify a meeting actually happened?
I'm not sure how to best ask this, but i'm looking to add some guard-rails into zoho for the end-user. However for guardrails to be effective they can't really add extra steps for the end-user. i.e. every step that's added for the user, is another placeAttachments should sync between Zoho Finance in CRM and Zoho Books
It would EXTREMELY helpful and practical if the attachments added to an invoice via Zoho Finance in CRM synced with the invoice updates in Zoho Books. Currently, attachments to an invoice updated in CRM DO NOT appear as attachments when viewing the sameIntroducing a new home page view and UI enhancements for Dashboards
Hello everyone, In CRM, the home pages provide a quick view of the various happenings in a business with the help of dashboards. The home pages also help to organize one's and the team's day's work. There are three views in the home tab: Classic User'sTranslation support expanded for Modules, Subforms and Related Lists
Hello Everyone! The translation feature enables organizations to translate certain values in their CRM interface into different languages. Previously, the only values that could be translated were picklist values and field names. However, we have extendedCall result pop up on call when call ends
I’d like to be able to create a pop up that appears after a call has finished that allows me to select the Call Result. I'm using RingCentral. I have seen from a previous, now locked, thread on Zoho Cares that this capability has been implemented, butData Template Amending
Hi, is it possible to remove data templates once you have applied them in Workdrive? Also, once I have added a new field to a data template can I mass update multiple files who have already been allocated that template and amend just that one addedZoho Flow y subformularios de Zoho CRM
Buenas tardes, En mi empresa vamos a empezar a usar los subformularios de zoho crm pero estos los voy a tener que rellenar con zoho flow ya que va a ser el encargado de rellenar dichos campos del subformulario. El problema es que a la hora de intentarRecurring Invoices
We are looking at moving our invoices to ZOHO Billing, I have started the trial period and like that I can et up for four different companies. The one feature we need which is mentioned in the documentation is Recurring Invoices so we can send our RentImplement Meeting Polls in Zoho Bookings
Dear Zoho Bookings Support Team, We'd like to propose a feature enhancement related to appointment scheduling within Zoho Bookings. Current Functionality: Zoho Bookings excels at streamlining individual appointment scheduling. Users can set availabilityZoho Projects App update: Arabic and Hebrew language support
Hello everyone! In the latest version(v3.10) of the Zoho Projects iOS app update, we have brought in support to access the app in RTL(Right to Left) languages (Arabic and Hebrew). Note: RTL is yet to be supported on the Calendar and Gantt charts modulesI want to cancel @mention group in the notes in Zoho CRM
Hi Everybody, I want to prevent people from mentioning a specific group in notes in Zoho CRM. We have one group called Team Sales, and although we've asked users not to mention groups, they still mention the group name. My workaround is to change theKaizen #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.How to install node packages in Zoho Creator cloud functions
I wanted to create some functions which requires node packages like axios, fetch, multer etc., How and where can i install the node packages in Zoho creator to use it in Zoho creator Nodejs function.Session "Ask Me Anything" Zoho France - Le 26 Juin 2025 14h à 17h (en Français
Chers Utilisateurs, Vous cherchez à mieux comprendre Zoho CRM ou Zoho Desk ? Nos experts seront disponibles pour répondre à toutes vos questions lors de notre session Ask Me Anything. Rejoignez-nous ici pour en discuter en ligne. Pendant trois heures,Option to Crop Existing Agent Image in Zoho One Directory
Hello Zoho Team, We hope you're all doing well. We would like to request a small but useful enhancement to the Zoho One Directory. 🎯 Current Limitation At present, the system allows cropping an agent image only during the initial upload of an agent'sIntroducing Sub-Accounts in Zoho Books!
Hello Everyone, Sub-Accounts is LIVE! Yes, you read it right. The much needed and most requested feature is now live in Zoho Books. The sub-accounts feature in Zoho Books will help you to classify your accounts further which will give you a more detailed view of your accounts while running reports. You can create sub-accounts for the below Accounts: Asset Cost of Goods Sold Expense Liability Fixed Asset Other Asset Other Current Asset Long Term Liability Other Current Liability Other Liability OtherSesión "Ask me anything" Zoho en Español - 26 de junio de 2025, de 14:00 a 17:00 (en español)
¡Hola Comunidad! ¿Quieres entender mejor Zoho CRM o Zoho Desk? Nuestros expertos estarán disponibles para responder a todas tus preguntas durante nuestra sesión "Ask me anything". Puedes comentar este artículo y durante tres horas, nuestro equipo estaráUI Update: We've Reorganized Invoice Settings
Dear users, We’ve reorganized invoice settings to offer you a streamlined and intuitive experience when managing your subscriptions. Starting from 2 July 2025, subscription-related invoice settings will be accessible from a new page called Billing PreferencesMarketer’s Space – Automate Subscription Management for CRM Contacts Using Workflows in Zoho Campaigns
Hello, marketers! Welcome back to Marketer’s Space. In this week’s post, we’ll look at how to simplify subscription management using Workflows for contacts synced from Zoho CRM in Zoho Campaigns. There are multiple ways to assign topics to your contacts:CRM and Finance Tab - Add Invoice "Subject " Column
When On a contact in CRM, and you click the Zoho Finace tab, how can I put in the invoice subject line? Or even a custom field for this. We need to see what that invoice is for, without opening it. If we have tons of invoices we need a way to quickWhatsApp to shift to per-message billing from July 1, 2025
Greetings Recruiters, If you’re using WhatsApp to connect with candidates through Zoho Recruit, there’s an important pricing change coming up that you’ll want to plan for. What’s changing? Starting July 1, 2025, WhatsApp is moving away from conversation-basedImplement full RTL support in Zoho Cliq, including text alignment and character positioning, regardless of the interface language.
Dear Zoho Cliq Support Team, We are writing to request a significant enhancement to the current RTL language support within Zoho Cliq. Currently, while Zoho Cliq allows users to input text in RTL languages, the text alignment remains LTR, resulting inEmail Alerts with Affected Flow Details When Deprecating Modules in Zoho Flow
Dear Zoho Flow Team, We would like to request an enhancement to the module deprecation process in Zoho Flow. 🧩 Current Limitation: Currently, when a module is deprecated by the Flow team: No email notifications are sent. There is no automated way toare there Url parameters to group records in the report/view?
There are URL parameters to filter records in target report. Is there any way to group records in report by certain field, using URL parameters or embed report parameters? Or any other workaround, apart from creating second report for dofferent grouping? Aim: I want to provide user a quick link to re-group embed report by different fields.Setvalue() client script not working
I have created a client script on the load the record(detail view page). I wanted to populate some default information in the single line field. for that I created the client script. below is the script: var field_obj = ZDK.Page.getField( 'Designation'Power of Automation :: Automate Deal Status Update in Zoho CRM upon Project Completion.
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:Leverage the power of Zia (AI) to create Marketing Projects in Zoho Marketing Plus
Hey everyone, Zoho's advanced AI assistant, Zia, now works with OpenAI to offer personalized marketing activity suggestions for your marketing projects in Brand Studio. With information such as your campaign's objective, duration, marketing channel types,Next Page