Zoho crm Logo

添加预约重新安排历史

目的

在预约重新安排历史记录中添加新记录。

端点

  • POST /Appointments_Rescheduled_History__s

Request 详情

Request URL

{api-domain}/crm/{version}/Appointments_Rescheduled_History__s

标题

授权:Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

范围

scope=ZohoCRM.modules.appointments_rescheduled_history.{operation_type}

可能的操作类型

ALL - 对预约重新安排历史数据的完全访问权限
CREATE - 在预约重新安排历史中创建新记录

样本请求

Copiedcurl "https://www.zohoapis.com/crm/v8/Appointments_Rescheduled_History__s "
-X POST
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

Request JSON 键

  • Appointment_NameJSON 对象,必填

    包含您正在为其创建重新安排历史的预约的名称和独特ID。您可以从 GET 预约 API获取这些详细信息。

  • 重新安排的时间字符串,必填

    表示重新安排预约的日期和时间。该值应以ISO 8601格式给出。

  • Rescheduled_ByJSON 对象,必填

    包含重新安排预约的用户的姓名和ID。您可以通过发起GET Users API调用来获取用户详细信息。

  • Rescheduled_From字符串,必填

    表示预约被重新安排的日期和时间。该值应以ISO 8601格式给出。

  • Rescheduled_To字符串,必填

    表示预约被重新安排的日期和时间。该值应以ISO 8601格式给出。

  • Reschedule_Note字符串,可选

    代表重新安排预约的原因。

  • Reschedule_Reason字符串,可选

    表示谁是重新安排预约的原因。
    可能的值:'By Customer' 和 'By Team'。

样本输入

Copied{
    "data": [
        {
            "Rescheduled_From": "2023-05-02T09:30:00+05:30",
            "Rescheduled_To": "2023-05-02T10:30:00+05:30",
            "Appointment_Name": {
                "name": "AC Repair - James",
                "id": "5545974000002555001"
            },
            "Rescheduled_Time": "2023-05-02T11:00:46+05:30",
            "Rescheduled_By": {
                "name": "Patricia Boyle",
                "id": "5545974000000393001"
            },
            "Reschedule_Note": "Customer unavailable",
            "Reschedule_Reason": "By Customer"
        }
    ]
}

注意

  • 您每次API调用最多可以创建100条记录,而对于单个预约,只能重新安排20条历史记录。

可能的错误

  • INVALID_DATAHTTP 400

    您在Rescheduled_By键或Appointment_Name键中指定了无效的ID。
    解决方案:进行GET Appointments API调用以提供有效的重新安排用户和预约ID。

  • INVALID_DATAHTTP 400

    Rescheduled_Time键的时间大于当前时间。
    解决方案: Rescheduled_Time的值应小于当前时间。

  • IN_REQUEST_LIMIT_EXCEEDEDHTTP 400

    您已尝试为一个预约创建超过20个重新安排的历史记录。
    解决方案:使用此API,一个预约只能创建20个重新安排的历史记录。

  • INVALID_MODULEHTTP 400

    您在请求URL中给出了无效的模块名称。
    解决方案:您只能在请求URL中使用Appointments_Rescheduled_History__s。

  • INVALID_REQUEST_METHODHTTP 400

    您给出了无效的HTTP请求方法类型。
    解决方案:在请求URL中只使用POST方法来访问此API。

  • MANDATORY_NOT_FOUNDHTTP 400

    您未指定任何必填字段。
    解决方案:错误响应中的'details'键将提供缺失的必填字段。您也可以参考上面的Request JSON键部分,找到其他必填字段。

  • INVALID_TOKENHTTP 401

    您使用了无效的oauth令牌。
    解决方案:您使用的访问令牌已过期。请刷新您的令牌并重试。

  • OAUTH_SCOPE_MISMATCHHTTP 401

    您使用了错误的oauth范围创建了授权令牌。
    解决方案:使用ZohoCRM.modules.appointments_rescheduled_history.CREATE或ZohoCRM.modules.appointments_rescheduled_history.ALL范围来创建一个新的有效授权令牌。

  • NO_PERMISSIONHTTP 403

    您没有权限创建任何重新安排的预约历史记录。
    解决方案:联系您的系统管理员。

  • NOT_ALLOWEDHTTP 403

    您试图在不重新安排预约的情况下进行录入。
    解决方案:任何预约都必须至少重新安排一次才能添加新的重新安排历史记录。

  • INVALID_URL_PATTERNHTTP 404

    检查您是否正在尝试访问正确的URL。
    解决方案:您给出了一个无效的请求URL。在URL中只使用/Appointments_Rescheduled_History__s端点。

  • INTERNAL_ERRORHTTP 500

    内部服务器错误
    解决方案:服务器中出现意外且未处理的异常。请联系我们的支持团队。

样本回应

Copied{
    "data": [
        {
            "code": "SUCCESS",
            "details": {
                "Modified_Time": "2023-05-02T12:35:36+05:30",
                "Modified_By": {
                    "name": "Patricia Boyle",
                    "id": "5545974000000393001"
                },
                "Created_Time": "2023-05-02T12:35:36+05:30",
                "id": "5545974000002556034",
                "Created_By": {
                    "name": "Patricia Boyle",
                    "id": "5545974000000393001"
                },
                "$approval_state": "approved"
            },
            "message": "record added",
            "status": "success"
        }
    ]
}