更新用户不可用时间
目的
要更新您在特定时间段内的不可用详情。
端点
- PUT /settings/users_unavailability
- PUT /settings/users_unavailability/{user_ID}
请求详情
请求 URL
{api-domain}/crm/{version}/settings/users_unavailability(或)
{api-domain}/crm/{version}/settings/users_unavailability/{id}
标题
授权:Zoho-oauthtoken <access_token>
范围
scope=ZohoCRM.settings.users_unavailability.ALL
(或)
scope=ZohoCRM.settings.users_unavailability.UPDATE
(或)
scope=ZohoCRM.settings.users_unavailability.WRITE
样品请求
Copiedcurl "https://www.zohoapis.com/crm/v8/settings/users_unavailability"
-X PUT
-d "@update.json"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"输入 JSON 键
- comments字符串,可选
当你不可用时,想让其他用户看到的备注。
- from字符串,如需更新此数据则为必填
你将从此时起不可用的日期和时间,须为 ISO8601 格式。
- to字符串,如需更新此数据则为必填
你将不可用至的日期和时间,须为 ISO8601 格式。
- id字符串,必填
在你将自己标记为不可用时响应中收到的记录唯一 ID。该 ID 可在 标记用户为不可用 API 的响应中获取。
注意
- 您可以更新开始时间、结束时间,或两者。
- 如果您未在URL中指定,输入中 "id" 是必填项。
示例输入
Copied{
"users_unavailability": [
{
"comments": "Unavailable - Updated the 'from' time",
"from": "2021-02-18T15:00:00+05:30",
"id": "554023000002221001"
}
]
}可能的错误
- MANDATORY_NOT_FOUNDHTTP 400
您未在输入或请求URL中指定ID。
解决方法:确保您在输入中包含了必填的键“id”及其值。 - INVALID_DATAHTTP 400
您指定了错误的ID,或者在“to”或“from”字段中指定了错误的时间。
解决方法:请指定正确的ID及采用ISO8601格式的正确时间。确保不可用时间段的开始时间早于结束时间。
示例回复
Copied{
"users_unavailability": [
{
"code": "SUCCESS",
"details": {
"id": "554023000002221001"
},
"message": "Unavailability updated successfully.",
"status": "success"
}
]
}