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
Look Up Field Type not available for events and tasks?
Look Up Field Type not available for events and tasks?I cannot check out to Zoho People.
When I tried to check out today, there's prompt that inhibits me to check out: To add entry in Attendance, log time for any of your jobsDigest Juin - Un résumé de ce qui s'est passé le mois dernier sur Community
Bonjour à toutes et à tous, Ce mois-ci encore, tout s’est enchaîné à toute vitesse ! On vous fait un petit récap de ce qui a marqué ces dernières semaines. Zoho RPA est une solution robuste d’automatisation des processus, conçue pour s’intégrer aux systèmesDifferent Transaction Series for Different Types of Sales
Is there any way I can create multiple transaction series for different type of Sales? Say B2B-001 and B2C -001 for respective type of Sales.?Unable to charge GST on shipping/packing & Forwarding charges in INDIA
Currently, tax rates only apply to items. It does not apply tax to any shipping or packing & forwarding charges that may be on the order as well. However, these charges are taxable under GST in India. Please add the ability to apply tax to these charges.Customer Advance Zoho Book API
All I could find was Customer Payment API, it does not have facility to add customer advances, where those are not linked to any invoice as such. How to do it?Even though the received amount+tax is equal to or lesser than the invoice value, zoho doesnt allow to record
Even though the received amount+tax is equal to or lesser than the invoice value, Zoho mentioned the error- you've recorded more payment than the actual invoice balance. please check again. screenshot also attached. You've recorded more payment thanMultiple deductions in invoice
I issue invoices to a customer that include multiple deductions that I would like to track in different expense accounts. But that is not possible in Zoho Books as there is only one Deduction field and even that I don't have control over to assign it#BiginnersTips | How to bulk update closing dates for multiple deals in Bigin
Hello Biginners! Keeping your CRM data accurate is crucial for any business- big or small. One key aspect is ensuring that closing dates for deals are always up to date. Why? Because if a deal is closed but not updated, your dashboards and reports would采购里出现付款通知 的错误
采购里面出现付款通知错误，怎么调整，我找不到路径，好像是ZOHO 自动生成的，请问怎么调整{"code":1002,"message":"Statement of Accounts does not exist."}
Hello Zoho team, I faced an issue while trying to POST a sales order from sap to zoho books, using the below data packet: { "customer_id": "4322967000027451968", "line_items": [ { "item_id": "2154170000010847685", "rate": "752.00",Add Custom Fields only in Customer module and not on supplier module!? Is not there a way to do that!?
I am trying to create custom fields on clients module but it also gets created on suppliers module; which of course does not make sense at all as a lot of custom fields are client or supplier specific but never both. I am missing something? This seemsLogging website service fees
Hello, I do a lot of freelance work on sites like Upwork and Wyzant and others and those companies take a small cut from what I pay or what I earn and I am wondering what is the correct way to log this in my books. For example if I charge $55 per hourHow do i clear a liability account without making a payment?
I have a liability account with a provision for an expected bill from previous years. However the bill never arrived and the provision/liability account with Cr balance has been carried forward for many years now. How do i know clear the provision made2 Transactions for single Expense
I have make 2 payments and have 1 Invoice containing both the items. My Bank Feeds show 2 Transactions, How can i associate them with Single Expense? I tried adding them to Advance Payment, but advance payment I can only apply to Bills It seems. Why cantEverything AI in Zoho Recruit – Webinar Recording Available!
AI is transforming the way recruiters find, engage, and hire top talent. In our latest webinar, we explored how Zoho Recruit’s AI-powered features can help streamline hiring, automate workflows, and improve decision-making. Missed the session? No worriesIntroducing the FTP task in Deluge
Hello everyone, We're excited to announce the launch of the FTP task, a powerful addition to Deluge that enables you to effortlessly transfer files between various Zoho apps and your own servers. Unlike the invokeUrl task, which supports various HTTPThe Social Wall: June 2025
Hello everyone, We’re back with June Zoho Social highlights. This month brought some exciting feature updates—especially within the Social Toolkit—to enhance your social media presence. We engaged with several MSME companies through community meet-upsCustom widgets on Zoho one dashboard
Is it possible to create custom widgets on the Zoho One dashboard? I see there is a widget name My Open Tickets to display open tickets in my view, but I would also like to have a widget to display unassigned tickets. A widget to display unfinished projectsData privacy concerns
Does Zoho team have access to my data in the database e.g. Balance Sheet, Bank account transactions, Profit & Loss statement etc.Ability to Remove/Change Zoho Creator Admins via Zoho One Interface
Dear Zoho One Team, Greetings, We would like to request a feature enhancement in Zoho One. Currently, it is not possible to remove or downgrade a user with the Admin role in Zoho Creator from the Zoho One admin interface. Unlike other Zoho apps whereZoho Sheets
Are they ever going to set up the feature "where I left off" just as you can do in Microsoft Excel online ? For me that is the only feature missing from Zoho sheets other than that I think they are terrific and use them every day. I only occasionallyCanvas Detail View Related List Sorting
Hello, I am having an issue finding a way to sort a related list within a canvas detail view. I have sorted the related list on the page layout associated with the canvas view, but that does not transfer to the canvas view. What am I missing?Mass Update in Zoho CRM
Hello, I want to update my past update records by using deluge on some conditions. anyone can please tell me how can I do it.Admin asked me for Backend Details when I wanted to verify my ZeptoMail Account
Please provide the backend details where you will be adding the SMTP/API information of ZeptoMail Who knows what this means?Action requested: Retain your sales journey configuration in Path Finder
Dear Customers, We hope you're well! As you might know, we're completely overhauling our journey management suite, CommandCenter, and are in the last leg of it. As a means of getting ready to go live, we will be announcing a series of requests and updatessearch layout in new version
Hello where is the menu for customizing search fields (module search layout) in the new zoho version (2016) ?? thanks nonoZoho Marketplace Analytcis
Hi Team, Our Zoho Marketplace Dashboard is not showing any data. What do you think we could do?if i have zoho one can i upgrade some of my staff from crm to crm plus within my organisation?
if i have zoho one can i upgrade some of my staff from crm to crm plus within my organisation? Or because I have many licenses of ZOHO ONE , IF I upgrade some staff to ZOGO CRUM PLUS. they will not be on the same organisatThe problem with Commerce ownership changing
Hi, I am changing the ownership of the company and trying to delete the previous user-owner. I changed the owner of the company from user Tatiana to user Eugene. Eugene is the owner of the organization. It's OK. I am now trying to remove the user Tatiana.Secondary Emails
I am having issues deleting a secondary email address from a couple of our users and need help. When in Directory, manage email addresses, I click the trash icon by the email address and confirm I am trying to delete the email. I click continue and IKaizen #121 : Customize List Views using Client Script
Hello everyone! Welcome back to another interesting Kaizen post. In this post, we can discuss how to customize List Views using Client Script. This post will answer the questions Ability to remove public views by the super admin in the Zoho CRM and IsPage Layouts for Standard Modules like CRM
For standard modules like quotes, invoices, purchase orders, etc, it would be a great feature to be able to create custom page layouts with custom fields in Zoho Books similar to how you can in Zoho CRM. For example, and my current use case, I have aZoho Books | Product updates | June 2025
Hello Users, We’ve rolled out new features and enhancements in Zoho Books, from the option to record advances for purchase orders to dynamic lookup fields, all designed to help you stay on top of your finances with ease. Introducing Change ComparatorsWidget Upload to CRM Fails with “Page Not Found” – Even with Correct Index Path
I'm building a simple widget to export Contact data to CSV in Zoho CRM, triggered via a custom button. The widget uploads cleanly, appears in the widget list, and is successfully assigned to a Contact detail view via a custom button. But when clicked,Account disabled
I have an issue I need help with. Whilst trialing ZOHO CRM I created the following: Account1 (-------------) using m__ame@m__rg___s__i__.___.__ and 2 personal emails Account2 (-------------) using a personal email and 2 users _al__1@______________._o_.__How can we manage the tags in ticket
Allowing agents to use Tags indiscriminately can cause havoc. We could not find tag management where 1. The admin can create Tags beforehand for use by Agents 2. Permission can be allocated which roles/profiles can use existing tags or add new tags 3.Feed Notifications filter?
I'd like to have filter settings for Feed Notifications just like we have for Personal Email. If someone dumps a bunch of files into a project, we get a notification for every file!Custom fields and filters for Timesheet
HI Zoho Projects team. IT would be great and useful if we can add custom fields to the Timesheet design And is needed more options for filtering the timesheet dashboard, like "Milestones" and task list asociated to the record. Thank youHow do I rename the dropdown that contains a form and a report?
I want to rename this, but I can't find howNext Page