- Overview
- What's New in V8?
- Changelog
- Open API Specification 3.0.0 (OAS)
- API Directory
- API Collection
- APIs and References
- OAuth
- API Limits and Credits
- Compliance
- Zoho CRM SDKs
- Metadata APIs
- Customization
- Process Automation
- Security control
- Roles
- Profiles
- Territories
- GETTerritories
- POSTTerritories
- PUTTerritories
- DELETETerritories
- POSTTransfer and Delete Territories
- GETChild Territories of a Territory
- GETTerritories Assigned
- GETAssociated User Count
- GETRetrieve User details Associated with a Territory
- PUTAssociate Users with Territory
- POSTRemove Territories of Records
- POSTAssign Territories to Records
- DELETEDisassociate Users from Territory
- Export Audit Log
- Portals
- Data Sharing
- Company Settings
- Zia
- Core APIs
- Records
- Merge Records
- Share Records
- Mail Merge
- Services
- Appointments
- Appointments Rescheduled History
- Fields Attachments
- Meeting Cancel
- Notes
- Mass Actions
- Related Records
- External ID
- Emails
- Subforms
- Linking Modules
- Others
- Bulk APIs
- Composite API
- Query API
- Notification APIs
Mark a User Unavailable
Purpose
To mark oneself(user) unavailable during a particular time period.
Endpoints
- POST /settings/users_unavailability
Request Details
Request URL
{api-domain}/crm/{version}/settings/users_unavailability
Header
Authorization: Zoho-oauthtoken <access_token>
Scope
scope=ZohoCRM.settings.users_unavailability.ALL
(or)
scope=ZohoCRM.settings.users_unavailability.WRITE
Sample Request
Copiedcurl "https://www.zohoapis.com/crm/v8/settings/users_unavailability"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-d "@input.json"
-X POSTInput JSON Keys
- commentsstring, optional
The comment you want other users to see while you are unavailable.
- fromstring, mandatory
The date and time in the ISO8601 format that you will be unavailable from.
- tostring, mandatory
The date and time in the ISO8601 format that you will be unavailable to.
- userJSON object
The name, id(mandatory, the key "id" from the Get Users API, and zuid(optional, the key "zuid" from the Get Users API.
Sample Input
Copied{
"users_unavailability": [
{
"comments": "Unavailable",
"from": "2021-02-18T19:00:00+05:30",
"to": "2021-02-18T20:00:00+05:30",
"user": {
"name": "Patricia Boyle",
"id": "554xxxx966",
"zuid": "554xxx5011"
}
}
]
} Possible Errors
- MANDATORY_NOT_FOUNDHTTP 400
One or more required fields is not specified in the input.
Resolution: The "details" key specifies the API name of the mandatory field you have not included in the input body. Include all the mandatory keys in the input. - INVALID_DATAHTTP 400
You have specified an incorrect ID in the "user" object, or you have specified an incorrect time in either the "to" or "from" fields.
Resolution: Specify the correct ID and the right time in the ISO8601 format. Ensure that the unavailability time period starts before the time it ends.
Sample Response
Copied{
"users_unavailability": [
{
"code": "SUCCESS",
"details": {
"id": "554023000002221001"
},
"message": "Unavailability created successfully.",
"status": "success"
}
]
}© 2025, Zoho Corporation Pvt. Ltd. All Rights Reserved.