Zoho crm Logo

将用户标记为不可用

目的

在特定时间段内将自己(用户)标记为不可用。

端点

  • POST /settings/users_unavailability

请求详情

请求 URL

{api-domain}/crm/{version}/settings/users_unavailability

标题

授权:Zoho-oauthtoken <access_token>

范围

scope=ZohoCRM.settings.users_unavailability.ALL
(或)
scope=ZohoCRM.settings.users_unavailability.WRITE

示例请求

Copiedcurl "https://www.zohoapis.com/crm/v8/settings/users_unavailability"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-d "@input.json"
-X POST

输入 JSON 键

  • comments string, optional

    当你不可用时,你希望其他用户看到的评论。

  • from string, mandatory

    你将从何时开始不可用的 ISO8601 格式的日期和时间。

  • to string, mandatory

    你将到何时结束不可用的 ISO8601 格式的日期和时间。

示例输入

Copied{
    "users_unavailability": [
        {
            "comments": "Unavailable",
            "from": "2021-02-18T19:00:00+05:30",
            "to": "2021-02-18T20:00:00+05:30"
        }
    ]
} 

可能的错误

  • MANDATORY_NOT_FOUNDHTTP 400

    输入中未指定一个或多个必填字段。
    解决方法:“details”键指定了您在输入主体中未包含的必填字段的API名称。请在输入中包含所有必填键。

  • INVALID_DATAHTTP 400

    您在“user”对象中指定了错误的ID,或者在“to”或“from”字段中指定了错误的时间。
    解决方法:请指定正确的ID和ISO8601格式的正确时间。确保不可用时间段的开始时间早于结束时间。

示例响应

Copied{
    "users_unavailability": [
        {
            "code": "SUCCESS",
            "details": {
                "id": "554023000002221001"
            },
            "message": "Unavailability created successfully.",
            "status": "success"
        }
    ]
}