更新预约
目的
更新您组织中现有预约的详细信息。
终端点
- PUT /Appointments__s
请求详情
请求 URL
{api-domain}/crm/{version}/Appointments__s
标题
授权:Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
范围
scope=ZohoCRM.模块.预约.{operation_type}
可能的操作类型
ALL - 完全访问预约数据
UPDATE - Update 预约数据
示例请求
Copiedcurl "https://www.zohoapis.com/crm/v8/Appointments__s"
-X PUT
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"请求 JSON 键
- id字符串,必填
表示需要更新的预约唯一ID。你可以通过获取预约(GET Appointments)API获得此ID。
- Status字符串,取消和完成时为必填项
表示预约的Status。
可能的取值:'已取消','已完成','已逾期' 和 '已安排'。 - Cancellation_Reason字符串,可选
表示谁取消了预约。
可能的取值:'由Customer' 和 '由团队'。默认值为 '由Customer'。 - Cancellation_Note字符串,可选
表示取消预约的原因。
- Appointment_Start_Time字符串,重新安排预约时必填
表示预约的起始日期和时间。该值应采用ISO 8601 格式。在示例输入中,使用这个键对现有预约进行了重新安排。
- Rescheduled_From字符串,可选
表示之前的预约时间From,即将预约时间重新安排到新的时间。Rescheduled_From时间应早于新的预约时间。该值应以ISO 8601 格式提供。
- Reschedule_Reason字符串,可选
表示是谁重新安排了预约。
可能的取值:'由Customer' 和 '由团队'。默认值为 '由Customer'。 - Reschedule_Note字符串,可选
表示重新安排预约的原因。
- Job_Sheet_Name字符串,可选
表示由成员在约会结束时指定的作业单的Name。它是服务中所执行任务的记录。当在约会Preferences中要求作业单时,此键为必填项。请调用GET 约会PreferencesAPI,以了解贵组织是否要求作业单。
- Job_Sheet_Description__s字符串,可选
对预约中所执行服务的描述。如果您的组织在预约偏好中强制要求作业单,则此项为必填。
注意
- 您也可以在请求中传递记录 ID。例如:{api-domain}/crm/v6/Appointments__s/{appointment_id}
- 除了 Service_Name 键之外,您可以通过 创建预约 API 更新所有其他请求 JSON 键。
- 每次 API 调用最多可更新 100 条预约记录。
- “已安排”是即将到来的预约的默认状态。当 appointment_start_time 超过当前时间时,通常会自动填充为“逾期”状态。仅当贵组织未配置“要求用户将预约标记为已完成”的预约Preferences时,才会自动填充为“已完成”状态。您可以使用 获取预约Preferences API 获取这些详情。
示例输入
Copied{
"data":[
{
"id": "5545974000002254155",
"Appointment_Start_Time": "2023-04-05T10:00:00+05:30",
"Reschedule_Reason": "By Team",
"Reschedule_Note": "Member is unavailable due to unexpected reasons"
},
{
"id": "5545974000002254060",
"Status": "Cancelled",
"Cancellation_Reason": "By Customer",
"Cancellation_Note": "Customer Unavailable"
},
{
"id": "5545974000002254135",
"Status": "Completed",
"Job_Sheet_Name": "Delivered",
"Job_Sheet_Description__s": "Delivered on time"
}
]
}可能的错误
- DEPENDENT_FIELD_MISSINGHTTP 400
您正在尝试重新安排预约,但未指定 Appointment_Start_Time 的值。
解决方案:重新安排预约时,Appointment_Start_Time 键是必填项。只有在已经重新安排过该预约后,您才能更新 Reschedule_Reason 和 Reschedule_Note 键。要了解某个预约已被重新安排的次数,请调用 GET Appointments API。 - DEPENDENT_FIELD_MISSINGHTTP 400
您正在尝试取消预约,但未指定“已取消”状态。
解决方案:取消预约时,必须指定“已取消”状态。 - DEPENDENT_FIELD_UNCHANGEDHTTP 400
您正在尝试将预约重新安排到现有的 Appointment_Start_Time。
解决方法: 重新安排预约时,新预约时间必须晚于现有的 Appointment_Start_Time。 - DEPENDENT_MISMATCHHTTP 400
您正在尝试使用无效的Status取消预约。
解决方法:要取消预约,Status键的唯一有效值是“已取消”。 - DEPENDENT_MISMATCHHTTP 400
您在预约时间结束前指定了“已完成”或“已逾期”状态。
解决方案: 只有在预约时间结束后,您才能将预约标记为“已完成”或“已逾期”。 - INVALID_DATAHTTP 400
您指定了无效的预约ID。
解决方法:请调用获取预约API,以获取您的组织中有效的预约ID。 - INVALID_DATAHTTP 400
您为状态键提供了无效的值。
解决方法:唯一允许的值为 “Scheduled”(已安排)、“Cancelled”(已取消)、“Overdue”(已逾期)和 “Completed”(已完成)。 - INVALID_MODULEHTTP 400
您在请求的 URL 中提供了无效的模块名称。
解决方案:您只能在请求的 URL 中使用 Appointments__s。 - INVALID_REQUEST_METHODHTTP 400
您指定了无效的 HTTP 请求方法类型。
解决方案: 在请求 URL 时,仅使用 PUT 方法来访问此 API。 - MANDATORY_NOT_FOUNDHTTP 400
您未提供需要更新的预约ID。
解决方案:请调用 获取预约 API,以获取您组织中现有预约的ID。 - INVALID_TOKENHTTP 401
您使用了无效的 OAuth 令牌。
解决方法: 您使用的访问令牌已过期,请刷新令牌后重试。 - OAUTH_SCOPE_MISMATCHHTTP 401
您使用了错误的 oauth 范围创建了授权令牌。
解决方法:请使用 ZohoCRM.modules.appointments.UPDATE 或 ZohoCRM.modules.appointments.ALL 范围来创建一个新的有效授权令牌。 - NO_PERMISSIONHTTP 403
您没有权限更新任何预约。
解决方案:请联系您的系统管理员。 - NOT_ALLOWEDHTTP 403
您尝试重新安排已完成或已取消的预约。
解决方法:您无法重新安排已经标记为已完成或已取消的预约。 - NOT_ALLOWEDHTTP 403
您尝试将已取消的预约标记为“已安排”、“已完成”或“逾期”。
解决方法:您不能更改已取消预约的Status。 - NOT_ALLOWEDHTTP 403
您已尝试将已完成的预约标记为“已安排”或“已取消”或“已逾期”。
解决方案:您不能更改已完成预约的Status。 - NOT_ALLOWEDHTTP 403
您尝试将预约标记为“已完成”。
解决方案:如果您的组织的预约Preferences中未配置“要求用户将预约标记为已完成”,则无法将预约标记为“已完成”。您可以通过Update预约PreferencesAPI来Update此偏好设置。 - INVALID_URL_PATTERNHTTP 404
请检查您是否正在尝试访问正确的URL。
解决方案:您提供了一个无效的请求URL。仅在URL中使用/Appointments__s端点。 - INTERNAL_ERRORHTTP 500
服务器内部错误
解决方法:服务器出现意外且未处理的异常。请联系我们的支持团队。
示例回复
Copied{
"data": [
{
"code": "SUCCESS",
"details": {
"Modified_Time": "2023-04-04T16:10:09+05:30",
"Modified_By": {
"name": "Patricia Boyle",
"id": "5545974000000393001"
},
"Created_Time": "2023-04-04T15:50:27+05:30",
"id": "5545974000002254155",
"Created_By": {
"name": "Patricia Boyle",
"id": "5545974000000393001"
}
},
"message": "record updated",
"status": "success"
},
{
"code": "SUCCESS",
"details": {
"Modified_Time": "2023-04-04T16:10:09+05:30",
"Modified_By": {
"name": "Patricia Boyle",
"id": "5545974000000393001"
},
"Created_Time": "2023-04-04T16:01:27+05:30",
"id": "5545974000002254060",
"Created_By": {
"name": "Patricia Boyle",
"id": "5545974000000393001"
}
},
"message": "record updated",
"status": "success"
},
{
"code": "SUCCESS",
"details": {
"Modified_Time": "2023-04-04T16:10:09+05:30",
"Modified_By": {
"name": "Patricia Boyle",
"id": "5545974000000393001"
},
"Created_Time": "2023-04-04T16:07:54+05:30",
"id": "5545974000002254135",
"Created_By": {
"name": "Patricia Boyle",
"id": "5545974000000393001"
}
},
"message": "record updated",
"status": "success"
}
]
}