Zoho crm Logo

创建预约

目的

向您的组织添加新的预约。

端点

  • POST /Appointments__s

Request 详情

Request URL

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

标题

授权:Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

范围

scope=ZohoCRM.modules.appointments.{operation_type}

可能的操作类型

ALL - 对预约数据的全面访问
CREATE - 创建新的预约

样本请求

Request JSON 键

  • Service_NameJSON 对象,必填

    包含您正在创建预约的服务的名称和独特ID。您可以从GET Services API获取这些详细信息。

  • 预约名称字符串,必填

    代表预约的名称,它接受字母数字字符。

  • Appointment_ForJSON 对象,必填

    包含您为其创建预约的客户的名称、ID和模块的API名称。客户可以来自联系人、潜在客户、账户以及其他包含客户数据的自定义模块。

  • 所有者bigint,必填

    代表将为此预约提供服务的服务成员的ID。发起GET 服务 API调用以获取服务成员的ID。您只能为一个预约添加一个所有者。

  • 预约开始时间字符串,必填

    表示预约的开始日期和时间。该值应以ISO 8601格式给出。

  • 位置字符串,必填

    表示提供服务的位置。 GET 服务 API将为您提供指定服务的可用位置。
    可能的值:与服务位置匹配的'客户地址'和'商业地址'。

  • 地址字符串,客户地址必填

    提供客户的地址,即将提供服务的地点。请进行GET联系人API调用以GET指定联系人的地址。您也可以根据客户的要求提供不同的地址。

  • 附加信息字符串,可选

    如果有的话,提供更多关于客户需求和服务的信息。

  • Remind_AtJSON 数组,可选

    包含您希望获得预约提醒的单位和期间的列表。
    单位键的值只能从 0到100。
    期间键的可能值为 分钟,小时和天。

  • 状态字符串,可选

    表示预约的状态。
    可能的值:'已取消','已完成','逾期'和'已安排'。

注意

  • 您每次API调用最多可以创建100个预约。

样本输入

Request JSON 键来创建重新安排的预约

  • Rescheduled_From字符串,创建重新安排的预约时必填

    表示从哪个之前的预约时间重新安排到新的时间。Rescheduled_From的时间应小于新的预约时间。值应以ISO 8601格式给出。

  • Reschedule_Reason字符串,可选

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

  • Reschedule_Note字符串,可选

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

创建重新安排的预约示例输入

Request JSON 键来创建一个已取消的预约

  • 状态字符串,创建已取消预约时必填

    表示预约的状态。创建已取消预约的可能值是 已取消。

  • 取消原因字符串,可选

    表示谁取消了预约。
    可能的值:'由客户'和'由团队'。默认值是'由客户'。

  • 取消备注字符串,可选

    表示取消预约的原因。

创建已取消预约的样本输入

可能的错误

  • DEPENDENT_FIELD_MISSINGHTTP 400

    您正在尝试创建一个已取消的预约,但未指定'已取消'的状态。
    解决方案:创建已取消的预约时,'已取消'的状态是必须的。

  • DEPENDENT_FIELD_MISSINGHTTP 400

    您正在尝试创建一个重新安排的预约,但未指定 Rescheduled_From 键。
    解决方案: 创建重新安排的预约,Rescheduled_From 键是必须的。

  • DEPENDENT_MISMATCHHTTP 400

    您已为过去的时间指定了'预定'状态的预约。
    解决方案:您不能为过去的日期和时间预定预约。您只能为过去的时间指定'逾期'或'已完成'的预约。

  • INVALID_DATAHTTP 400

    您指定的用户ID无效,或者该用户不是服务成员的一部分。
    解决方案:进行GET Services API调用,提供一个有效的所有者ID,该ID是服务成员的一部分。

  • INVALID_DATAHTTP 400

    您已经以错误的格式指定了Remind_At键的值。
    解决方案: Remind_At键的值应以JSON数组的形式给出,其中应包含单位和周期键。
    单位键的数据类型是数字,应在0到100之间。
    周期键的数据类型是字符串,唯一可能的值是'分钟','小时'和'天'。

  • INVALID_DATAHTTP 400

    您为位置键提供了无效的值。
    解决方案:唯一可能的值是'客户地址'和'商业地址'。

  • INVALID_DATAHTTP 400

    您指定的预约地点与服务地点不匹配。
    解决方案:进行GET Services API调用以GET您想要创建预约的服务的地点。

  • INVALID_DATAHTTP 400

    您为Appointment_Start_Time键提供了无效的值。
    解决方案:在为Appointment_Start_Time键提供值之前,先进行GET Services API调用,了解特定服务的可用时间。确保预约开始时间在服务的可用时间范围内。

  • INVALID_MODULEHTTP 400

    您在请求URL中给出了无效的模块名称。
    解决方案:您只能在请求URL中使用Appointments__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.CREATE或ZohoCRM.modules.appointments.ALL范围来创建一个新的有效授权令牌。

  • NO_PERMISSIONHTTP 403

    您没有权限创建任何预约。
    解决方案:联系您的系统管理员。

  • INVALID_URL_PATTERNHTTP 404

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

  • INTERNAL_ERRORHTTP 500

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

样本回应