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
What happened to the tabs in the ribbon on the top in my CRM?
Hi, This morning all of the tabs (modules) in the ribbon on top are no longer showing up. I had the modules in the ribbon in a specific order for easy, one-click access. Now it's only showing the active tab and the rest are hiding under the three dotsConnect to Australian bank
How do I connect to an Australian bank. No Australian bank shows up in my list. I think its because the service provider is Token and not Yodlee. How do I change this?Searching for content within courses
Hello, I have been testing out Zoho One for my company have been exploring Learn. I've noticed that you cannot search for content within a course. You can only locate the title of the course. Example: Course: How to Make Your Bed Chapter: Pillows Lesson:Citations Problem
I'm having an odd problem with the "Add Citations" feature of Zoho Writer. When I add a citation using the "Fetch website details online" feature it works the first time I use it but if I try it a second time by clicking that link nothing at all happensZoho People Leave Balance Show as Negative
Hi All I have the Portugal material Leave that policy allows up to 120 days or 150days for employee to apply within 365 days and employees is able to take minimum of 1 days or up to 120 days In my Leave Grant I have set as the setting.Zoho People > Performance > Appraisal > Mismatch between the template-configured module and the currently enabled module.
Hello There When we enable the performance module there a prompt Mismatch between the template-configured module and the currently enabled module. How do we resolve thisIntroducing WhatsApp integration in Bigin
Greetings! In today's business landscape, messaging apps play a significant role in customer operations. Customers can engage with businesses, seek support, ask questions, receive personalized recommendations, read reviews, and even make purchases—allZoho People Leave Application Module Error: Leave balance has exceeded as on 09-07-2025.
Dear All I need to check how do i resolve the issue of Error: Leave balance has exceeded as on 09-07-2025. All my leave have this issuePower of Automation:: Daily Time log summary broadcast to Zoho Cliq using Schedule Custom Functions
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:When Calls Ends, Creating Note with the call description by deluge code
Hi, i need help with writing deluge code function, to scenario is like this - i want to create a workflow thats after 10 that the call ends the deluge function will create a new note in module calls that link the note in module calls to the his lead ticketDefault Memo from Custom Field (from Bill) when Paying with Check
Hi, we are using "Pay via Check" option to pay for our Bills in Zoho Books. I would like the memo on the check to pull directly from one of the custom field values within the Bill. Is there any way I can do this? The memo that I need is already on theWouldn't it be great to have an option to schedule sending emails in Zoho mail? Schedule send feature request
The subject says it all - but just to clarify: This is to request a new feature that would allow users to schedule the delivery of an email for a given date & time. In small companies it is quite common to work unsocial hours on customer emails. But someStatic vs Standard Subforms - New Feature; But how does it work?
I've just noticed that we now have the option of static or standard subforms, but I can't find any posts on the new feature. So, how does the new subform type work?【Zoho CRM】翻訳機能のアップデート
ユーザーの皆さま、こんにちは。コミュニティチームの藤澤です。 今回は「Zoho CRM アップデート情報」の中から、翻訳機能のアップデートをご紹介します。 翻訳機能が拡張され、Webタブ、レイアウト、セクション、ウィザード、ウィザード画面、セグメントも翻訳できるようになりました。 翻訳をエクスポートする際に、これらの要素に対応する用語もエクスポート先の言語で追加されます。 ※過去の関連記事はこちらから まず、翻訳の設定画面から「エクスポート」を選択してください。すると、TXT形式のファイルがローカル環境に出力されます。Trying to make zoho invoice have a button
Hello I am getting this error with the code below. Anyone know how to fix? Check and update the code in line 5 as there is a Exception : Variable 'invoice_id' is not defined // Define Organization ID (Replace with your actual Zoho Invoice organizationDuplicate Contacts - how to get merge or delete
I have noticed that our list of contacts in Zoho Desk duplicates contacts periodically. I have yet to identify when or why. How do I merge or delete them? I see there is a "Deduplicate" but I am unable to find anything that explains this feature.Another nightmare experience with a "Zoho Partner": Cloud Z Technologies
I found "CloudZTech" on fiverr and I hired them to do a simple $300-$500 task. They did not deliver on time and I was forced to fire them. You guys must watch out for these fake ZOHO PARTNERS, 99% of them don't have the expertise necessary to help. IPickup and delivery
Some of our products are pickup only and some delivery. Is there a way of doing this in commerce. Plus we give volume discount to all customers. We handle this in Books using pricelist and range pricing. Is there a way of doing this within commerce.Unable to change the "credentials of login user" option when creating a connection
I want to create a new Desk connection where the parameter to use 'credentials of login user' is set to YES. I'm able to create a new connection but am never given the option to change this parameter. Is this a restriction of my user profile, and if so,How can you train the Zia Bot for Desk
I added the Zia bot to my portal, but it's rarely able to answer questions, even when I have dedicated articles for the question. How can I best train it? Should I change the title of my articles, add more information inthe body copy?Direct Download Link
I saw how to share off a document to the public, which is great, but I was also wondering if there is a way to get a direct download link for a zoho doc. I would like to be able to simply send people my documents without them having to find download on the zoho page (not hard, but just for convenience)Form responses to quote process
Hello, so I am new to Zoho One. I'm fairly confident what I want to do can be done I just need guidance on how to accomplish it. I have a Zoho Form. When a customer fills out the form I want to generate a quote (that I will email to them, I do NOT wanti keep see there is a connetion issue connecting 3rd party api on zoho when using zia
hi there , i have set up open ai api to zoho zia (copied and pasted to zoho zia) but I keep getting notificaiton "there is a connetion issue connecting 3rd party api on zoho" when using zia on top when click zia and try to type in word thereIPv6 MX Support in 2025
There are multiple discussion on this community on IPv6 adjacent issues though the most pressing issue for IPv6 support is not solved yet the support team seems to not understand what is the issue and is steering the conversation to the wrong and misleadingZoho Books Quote - Client cannot accept quote
We are using the Zoho One plan and some of our clients have reported that they cannot accept the quote when we select their email at the bottom to send the quote to. When trying to accept, the quote prompts a message saying "You are not allowed to acceptReckon Accounts Hosted to Zoho Finance
Hi Everyone I want to transition from Reckon Accounts Hosted to Zoho Finance, as I have numerous other tasks in Zoho One, and it seems logical to make the move. (Reckon has a QuickBooks back end & is hosted on Assure now, think) I would really like toFlex Your Creativity – A New component to Canvas in Zoho CRM
Hello Everyone We’re excited to introduce Flex, a new component for Canvas in Zoho CRM! Flex is here to give you greater control over how your data is displayed in your layouts. This component enables responsive layouts that adapt across different screenVendor Assignment issue for staff in User Roales
there is a limitation in software that we can't assing Vendors to our staff - we can only assign Customers on staff wise!! There is a limitation of this software that in case i want to assign limited vendors to my staff - it's not possible. Either i willZoho Desk Community Portal Not Displaying Custom Styling Correctly
Hi Zoho Community, I’m struggling to get a custom community portal in Zoho Desk to display my branding and styling correctly, and I’d love some help troubleshooting this for a client’s support portal. Details: Setup: Zoho Desk (Professional plan, latestRemove or hide default views
I'm looking to only have the views pertinent to my organization. Is there a way to show only my custom views (or separate them to a different area or something)? If not, this should be a feature as switching from Zendesk we had this option...Wie kann ich einen Nutzer löschen?
Wir haben Zoho one. Es handelt sich um einen ehemaligen Mitarbeiter.Function #46: Auto generate list of lapsed customers using Custom Button
Hello everyone, and welcome back to our series! Customer retention is one of the key factors that impact the long-term success and sustainability of a business. High customer retention rates indicate satisfied customers, quality products or services,Before Going To The Qc stage , site ready ness file upload mandtoty how to achive this in the blue print transition
Before Going To The Qc stage , site ready ness file upload mandtoty how to achive this in the blue print transition Is it possible on click of the predelivery Transition show the alert message if site ready ness file upload empty also not move the stageAnnouncing new features in Trident for Windows (v.1.28.5.0)
Hello Community, Trident for Windows is here with exciting new features to help you stay productive and make collaboration simpler. Let’s dive into what’s new! Slash commands are now supported in the Cliq module. You can now use slash commands from theConvert time to string and remove second
Hello everyone, I have a question that I can't figure out on my own. How to convert time into string (singleline) and remove second. Like HH:mm. If I convert it as below, the result becomes null. Thank you very much. input.Time.tostring("HH:mm") result:Has anyone imported items and included the storage bin?
We have a large amount of Inventory Items. We would like to import these into Zoho Inventory but while we can import the majority of data, the storage bin refuses to map. Has anyone successfully imported the data and mapped the bin?Terms & Conditions add a rule.
Hi I'd like to format my T&C's to auto format a Deposit amount based on the Total. "Quotation is valid for 7 days from the date of issue. A 75% deposit ( R .00 )is required to confirm the booking. The remaining balance ( R .00)is due upon project completion.Zoho Inventory Feature Roadmap Visible To All
Hello, please consider making your feature roadmap visible to us users so that we know what to expect in future. This may appease current users who are seeking clarification on feature implementation dates, so that they can make an informed decision whethersend file to ftp or another external service
i'v created a zoho creator application for take a picture and rename it by phone. Now i need to send Each renamed pictures to my ftp or to specific folder on google drive...then, delete it from creator. (every picture recived it will processed by another program and stored on my Erp) HOW CAN I DO ??Feature Request - Improved booking layouts, specifically for individual booking links
I would like to see more layout options and specifically to have the meeting description beside the calendar booking function, when sharing booking links to specific consultations/meetings. Below is a screenshot from Calendly. I love this layout and itNext Page