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
Extensions 101 webinar series: Build, integrate, and monetize with extensions
Attention developers! Are you ready to take your extension development skills to the next level? We're excited to bring back the Extensions 101 webinar series with an expanded lineup of Zoho products and an introduction to more platform features. LastOverride Auto Number field?
We are preparing to migrate from Salesforce. In Salesforce, we auto-generate a unique number on our Opportunities (Potentials). If the Opportunity results in a contract, we use that unique number as the Contract number. There are some situations whereSwitching hosts while meeting is occuring
We had a team meeting in Zoho Meetings this morning, but the person listed as the host had to leave the meeting early. We looked for an option to set me to host, but didn't see the option, and we incorrectly assumed that it would be like Zoom in thatRefund Form Can’t Reverse “Bank Charges” Line — Throws Off Reconciliation
Zoho, When we pay a vendor, the Payment screen lets us add a “Bank Charges” amount (we post a $1 processing fee there). Perfect. But on the Refund popup there’s no matching field, so the refund can only return the net expense. If our processor sends backTrigger for Validation Rules
Currently in Zoho CRM we can set a trigger for workflows, blueprints etc in a custom deluge function But Validation Rules are missing For example if I run a custom function to update a record, it bypasses the validation rules It would be really beneficialZOHO Desk blocking emails from creating tickets
Hi We have been noticing some issues since last week ZOHO Desk is not creating a ticket which is still in our affiliate mail box.how to install desk
how to install deskHow to turn off ability to share Knowledge-base article with social networks
Is there a way to deactivate the link at the bottom of a Knowledge-base article so that it can not be shared via Facebook or Twitter?Automatically Hide Unauthorized Sections from Agent Interface in Zoho Desk
Hello Zoho Desk Team, We hope you're doing well. We’d like to submit a feature request regarding the user experience for agents in Zoho Desk who do not have permission to access certain sections of the system. 🎯 Current Behavior At present, when an agentIs there a way to prevent a user from removing a payment method on a live, recurring subscription?
As it stands, if you allow users to remove payment methods, they can do so on live subscriptions. This leaves the sub without a payment method. The user should be able to REPLACE the card with a new one, but not remove all payment methods. We have hadAssistance Required: Report Export to Excel and WorkDrive Upload via Deluge
I'm working on automating a scheduled workflow in Zoho Creator that needs to run weekly. The goal is to: Export a report from Zoho Creator in Excel (.xls or .xlsx) format, and Upload the exported file to a specific folder in Zoho WorkDrive using a DelugeKanban View for Projects.
At our organization, we describe active projects with various statuses like "In Proofing" or "Printing" or "Mailing". In the Projects view, one can set these project statuses by selecting from the appropriate drop-down. While this works, it's difficult to view and comprehend the progress of all of your projects relative to each other in a table. Creating a Kanban view for projects where I can move them from one status to another allows me to see where each project is in the order of our workflow.Useful enhancements to Mail Merge in Zoho CRM
Dear Customers, We hope you're well! We're here with a set of highly anticipated enhancements to the Mail Merge feature in Zoho CRM. Let's go! Mail Merge in Zoho CRM integrates with Zoho Writer to simplify the process of customizing and sharing documentsHow can I see the actual copy sent to the specific contact?
I have setup a journey in Marketing Automation and created addition of contact in a specific list as the trigger, emails are sending to the contacts, but I can't see the actual copy sent to any specific contact in the list. Please guide me, where canClient Script for Task Module
When do we expect the client script for the tasks module?Formula Fields inside of Blueprint Transitions
We would like to have formula fields inside of blueprint transitions. We type in currency fields and would like to see the result inside of a formula field. Our use case: Send out a price for XY 1. Filling out cost fields 2. See gross profitinventory based on bills and not physical stock
Hello, I have noticed a very annoying issue with zoho books/inventory. I use composite items. If I have an sub assembly item on back order, I am unable to make up the composite item, even when I have received the goods and it is in my stock. I have to convert the PO into a BILL in order for the item to show as 'Accounting Stock'. The problem is that the supplier Invoice is not shipped with the goods, but can follow even a week later. So I have to make the bill have a 'dummy name and number' untilUsing Zoho Inventory for managing Item compatibilities
Use case: Using Zoho Inventory for managing (as an example) aftermarket car parts, where a single part can suit many makes, models and years. How do most businesses assign and manage compatibility for each part? Do ZI users typically do this using multi-selectUnable to enter manual journal entries in AR/AP.
Hi there, i am facing some problem relating to AR/AP. I want to make some entries in AR/AP through manual journal. for example. some time I send cash 500 to Mr. A (Customer) for any purpose and then after 2 or 3 days Mr. A returned back 700 to me andQuestions regarding WorkDrive
Here are my questions regarding WorkDrive: Does WorkDrive have a limit on the number of downloads? What will happen if a file is downloaded excessively? Does WorkDrive have any restrictions on download speeds? Are there any limitations on downloadingHow to record tips from customers
I run a cleaning service business and on occasion customers include a tip with their check payment. How can I record the amount paid for service and the tip separately? Any amount over the invoice is looked at as an overpayment and suggest a credit noteMulti-currencies in Zoho Books
I'd like to request multiple currencies in Zoho Books. I have customers paying in USD, CAD, CNY. I need to bill customers in these currencies too. I can set up a base currency, and then set up a exchange-rate table to convert these currencies.I want refund of Zoho standard subscription on WEB payment
Hi, Kindly help to refund the WEB payment made on 13/07/2025 for Zoho standard annual subscription. I didn't find the software useful for my project. RegardsIs Conditional display of field(s) possible in a Canvas Customer Portal?
Is Conditional display of field(s) possible in a Canvas Customer Portal? How?Automate Backups
This is a feature request. Consider adding an auto backup feature. Where when you turn it on, it will auto backup on the 15-day schedule. For additional consideration, allow for the export of module data via API calls. Thank you for your consideration.View Linked Subscription on Invoice list
When looking at the list of invoices in billing is it possible to see the subscription that an invoice is for. This would allow you to see if it's a subscription a customer is behind on, or they simply haven't paid a one time invoice.Recording Credit Card Fees when Recording Payment for Bills
It seems I am unable to record credit card fees when paying a bill. I pay close to 100% of my bills with a company credit card via online portals. I'm happy for the CC fess to be recorded as Bank Charges but it will not allow that field to be used ifWorkerly/Zoho One Pricing
Hi What is the pricing model that is suppose to be as a Zoho One user? If i use the services of a freelancers or temp workers (Sometimes for a few hours a week/month), I need to purchase a zoho one license for each of them as well as workerly licencDKIM
I have my DKIM in Titan, which is another email service provider. I get this notification on my portal. What shall I do? ( Improve the deliverability of emails sent from Zoho Social by adding DKIM (DomainKeys Identified Mail) records to your DNS settings.Show All Notes For A Single Record
I would like to be able to view a list of all Notes for a particular record. We can add several (unlimited) Notes for the Leads, Contacts, Accounts and Potentials records. The subject line and some of the note content for up to 10 notes is visible on the first page. You can select the arrow to view additional notes in the list. I would like a button next to the New Note button that says View All. This would bring up a printable list of all notes listed in descending order by Modified Time (newestZoholics Europe 2025: Build Smarter with the Zoho Creator Low-code Workshop!
Why should you attend? This year, Zoholics Europe 2025, Zoho’s official user conference, is your opportunity to connect directly with the teams behind the tools you use every day. Don’t miss one of the most requested sessions: dedicated, hands-on workshopAssigning multiple roles to a user in Creator
Hi I find we can assign only one role and permission to an user in creator. There is a requirement to assign multiple roles and corresponding permission to one user. Is there any solution or workaround for this? Refer the screenshot below【Zoho CRM】ウィザード機能のアップデート：セクション要素の追加
ユーザーの皆さま、こんにちは。コミュニティチームの中野です。 今回は「Zoho CRM アップデート情報」の中から、ウィザード機能のアップデートをご紹介します。 ウィザード機能に新たに「セクション要素」が追加されました。 各ウィザード画面内で項目、テキスト、サブフォーム、ウィジェット要素などをより柔軟に整理できるようになりました。 セクション要素とは？ ウィザードの中で、関連する項目や要素をひとつの「サブエリア」 としてまとめられる新しい構成要素です。 セクション要素活用メリット 入力内容やプロセスによっては、より細かな構造や階層化が求められる場合があります。Edit PDFs from within your web app using Zoho Office Integrator
Hi users, We are excited to introduce PDF editing capabilities in Zoho Office Integrator. You can now open, edit, and collaborate on PDFs from within your web app—in addition to documents, spreadsheets, and presentations—and save them in your configuredZoho CRM Workflow and Function Backup Options
Hi everyone! I have been able to make several backups of my CRM data and noticed that the Workflows and Functions are not included in these backups. To my knowledge, there is no backup feature for workflows and functions, which is problematic in of itself.Zoho Recruit > Job Opening Module> Editing, Deleting, Adding (Fields)
Hello All In the Job Opening Modules How do i go about deleting the Positing Title or changing to Job Title or can i hide it from all? I want to add a Look Up User Field, however when i select the look up field i do not see that Can i have the industryCan you create a lead without assigning an owner?
Here is the question I have: Is there a way I can create a bunch of leads without assigning it an owner? What I want is for my salespeople to pick and choose their own leads without me assigning them.. right now all leads are owned by me becauseBug - Incorrect example in the documentation
I found an issue in the Zoho API documentation. The example "Sample Request" on this page is incorrect — it shows the example for "Get Email Attachment Info" instead of "Get Email Attachment Content". Wrong example: curl "https://mail.zoho.com/api/accounts/12345678/folders/9000000002014/messages/1710915488416100001/attachmentinfo"Power of Automation :: Dynamically generate Tasklists based on values selected in Task Custom Fields
Hello Everyone, A custom function is a software code that can be used to automate a process and this allows you to automate a notification, call a webhook, or perform logic immediately after a workflow rule is triggered. This feature helps to automateWhatsApp Enhancements to Boost Customer Engagement
We're excited to introduce a series of powerful enhancements to the WhatsApp integration in Zoho FSM, making customer interactions faster, smarter, and more actionable—right from your Zoho FSM interface. Here’s a quick rundown of what’s new: Try It OutNext Page