Zoho crm Logo

更新服务

目的

更新您组织中现有服务的详细信息。

端点

  • PUT /Services__s

请求详情

请求 URL

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

标题

授权:Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

范围

scope=ZohoCRM.modules.services.{operation_type}

可能的操作类型

全部 - 完全访问服务数据
Update - Update服务数据

示例请求

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

注意

  • 右侧的示例输入部分提供了一个针对创建服务API中讨论的示例服务的更新请求正文。

请求 JSON 键

  • id字符串,必填

    表示需要更新的服务的唯一ID。请调用 获取服务 API 来获取服务的ID。

  • 持续时间整数,必填

    表示该服务提供的时长。
    可能的取值:只接受以分钟为单位的数值,应大于15分钟且小于1,440分钟。

  • 地点字符串,必填

    提供服务的地点。
    可能的取值:‘客户添加’、‘商家添加’和‘商家添加与客户添加’。

  • 成员对象,必填

    包含执行该服务的用户ID。您最多可以为一个服务添加100个成员。

  • Availability_Type字符串,必填

    表示客户服务的可用天数。
    可能的取值:“每个工作日”、“指定日期范围”、“指定日期”和“指定星期几”。
    在示例输入中,可用类型由指定星期几更改为指定日期范围。

  • 可用_From字符串,仅在特定日期范围时为必填项

    表示服务对客户开放的From。

  • Available_Till字符串,特定日期范围时为必填项

    表示该服务对客户可用的截止日期。

  • Available_Timings数组,可选

    包含在指定可用天数/日期内为客户提供服务的可用时间。最多可以输入两个自定义时间段。请注意,自定义可用时间应等于或大于服务时长。默认值与组织配置的营业时间相同。

  • 税费数组,可选

    包含应用于服务费用的税费 ID 和数值。您可以通过服务模块的 GET 字段 API 获取税费 ID 和数值。
    示例输入中添加了几个税费作为参考。

  • Job_Sheet_Required字符串,可选

    表示成员在每次服务预约结束时是否需要填写工作单。
    可能的值:'Yes' 和 '否'。默认值为 No.
    示例输入用于禁用某项服务的工作单需求。

  • Job_Sheet_Section__s字符串,当 "Job_Sheet_Required":"Yes" 时必填

    表示必须与服务关联的作业单。您可以调用 获取字段 API 以获取您组织中的可用作业单。要为某个服务禁用作业单,此键必须赋值为 'null'。

  • Status 字符串,可选

    表示服务是否处于启用状态。
    可能的取值:‘可用’,‘暂时不可用’ 和 ‘未启用’。默认值为可用。
    在示例输入中,Status已从“可用”更改为“暂时不可用”,以便您理解。

  • Unavailable_From字符串,当状态为“暂时不可用”或“未使用”时为必填项

    表示该服务自From起对客户不可用的日期和时间。该值不能大于当前时间。同时,时间应以ISO 8601 格式提供。

  • Unavailable_Till字符串,当状态为可用时必填

    表示服务对客户不可用的截止日期和时间。应以ISO 8601 格式提供。

注意

  • 您也可以在请求中传递记录ID。例如:{api-domain}/crm/v7/Services__s/{service_id}
  • 您还可以使用创建服务API中提到的其他请求JSON参数,根据您的业务需求来更新服务数据。
  • 每次API调用最多可更新100个服务。

示例输入

Copied{
    "data": [
        {
            "id":"5545974000002183001",
            "Duration": "60",
            "Location": "Business Address and Client Address",
            "Members": [
                {
                    "Members": {
                        "id": "5545974000000393002"
                    },
                    {
                        "id": "5545974000000393003"
                    }
                }
            ],
            "Availability_Type": "Specific Date Range",
            "Available_From": "2023-03-24",
            "Available_Till":"2023-10-01",
            "Available_Timings": [
                {
                    "From": "10:00",
                    "To": "13:30"
                },
                {
                    "From":"15:00",
                    "To":"18:00"
                }
            ],
            "Tax": [
                {
                    "id": "5545974000000021001",
                    "value": "Sales Tax - 2.0 %"
                }
            ],
            "Status":"Temporarily Unavailable",
            "Unavailable_From": "2023-03-31T10:00:00+05:30",
            "Unavailable_Till": "2023-04-14T10:00:00+05:30",
            "Job_Sheet_Required": "No",
            "Job_Sheet_Section__s": null
        }
    ]
}

可能的错误

  • DEPENDENT_FIELD_MISSINGHTTP 400

    您未提供 Availability_Type、Status 和 Job_Sheet_Required 这些依赖字段。 
    解决方案:请检查请求的 JSON 键部分,并填写相关依赖字段。

  • DEPENDENT_MISMATCHHTTP 400

    您为 Unavailable_Till 提供了无效的数值。
    解决方案:当状态为暂时不可用时,'Unavailable_Till' 的值应大于当前时间。如果状态为可用,键的值应小于当前时间。

  • DEPENDENT_MISMATCHHTTP 400

    “Unavailable_From” 或 “Unavailable_Till” 中的任意一个在可用状态下被指定。
    解决方案: 当状态为可用时,可以选择不指定“Unavailable_From”和“Unavailable_Till”这两个键,或者同时指定这两个键。不能只指定其中一个键。

  • DEPENDENT_MISMATCHHTTP 400

    当 Job_Sheet_Required 键被指定为 'No' 时,不能指定 Job-Sheet_Section__s。
    解决方法:只有在 Job_Sheet_Required 被指定为 'Yes' 时,才应提供 Job_Sheet_Section__s。

  • DEPENDENT_MISMATCHHTTP 400

    所指定的可用时间、可用天数或可用日期未在组织的营业时间或工作日内。
    解决方法: 调用 获取营业时间 API,并在组织的营业时间内指定有效参数。

  • INVALID_DATAHTTP 400

    您提供了无效的 Availability_Type。
    解决方案: 您应指定以下任意一个选项:“每个工作日”、“特定日期范围”、“特定日期” 和 “特定星期几”。

  • INVALID_DATAHTTP 400

    在 Available_Dates 键中指定的日期格式无效。
    解决方法: 仅使用 YYYY-MM-DD 格式表示日期。

  • INVALID_DATAHTTP 400

    Available_Timings 中的 'From' 或 '结束时间' 键无效。
    解决方法: 自定义可用时间必须以24小时制格式提供。

  • INVALID_DATAHTTP 400

    您指定了无效的持续时间值。
    解决方案:持续时间不能少于15分钟且不能大于1440分钟。请注意,该值应始终以分钟为单位。

  • INVALID_DATAHTTP 400

    指定的 Available_Timings 不满足服务时长。
    解决方法:Available_Timings 键的值应等于或大于服务时长。

  • INVALID_DATAHTTP 400

    您提供了无效的Status值。
    解决方法:唯一可用的取值为 “可用”、“暂时不可用” 和 “未使用”。

  • INVALID_DATAHTTP 400

    您为 Unavailable_From 提供了无效的值。
    解决方法:请确保 'Unavailable_From' 的值不大于当前时间。

  • INVALID_DATAHTTP 400

    您在 Members 键中指定了未确认或未激活的用户 ID。
    解决方法: 您只能将已激活且已确认的用户添加为组织的服务成员。

  • INVALID_DATAHTTP 400

    Available_Till 键的值不大于 Available_From 键的值。
    解决方案: 当服务的 Availability_Type 为“特定日期范围”时,Available_Till 日期应大于 Available_From 日期。

  • INVALID_MODULEHTTP 400

    请求中的模块名称 URL 似乎无效。
    解决方案:你只能在请求的 Services__s 中使用 URL。

  • INVALID_REQUEST_METHODHTTP 400

    所提供的 HTTP 请求方法类型无效。
    解决方案:在请求 URL 时,仅使用 PUT 方法来访问此 API。

  • LIMIT_EXCEEDEDHTTP 400

    您已超出组织中可用活跃服务的最大数量限制。
    解决方案:一个组织中最多可以有500个活跃服务。

  • OAUTH_SCOPE_MISMATCHHTTP 401

    您使用的令牌是使用错误的 OAuth 范围创建的。
    解决方案:请使用 ZohoCRM.modules.services.CREATE 或 ZohoCRM.modules.services.ALL 范围来创建一个新的有效令牌。

  • INVALID_TOKENHTTP 401

    您使用了无效的 OAuth 令牌。
    解决方法: 您使用的令牌已过期。请刷新您的令牌后重试。

  • NO_PERMISSIONHTTP 403

    您没有权限发布任何服务。
    解决方法:请联系您的系统管理员。

  • NOT_ALLOWEDHTTP 403

    在服务 Preferences 中,您的组织尚未配置作业单。
    解决方案: 请在创建带有作业单的服务前,先启用作业单首选项。您可以使用 Update服务Preferences API Update相关配置。

  • NOT_ALLOWEDHTTP 403

    您已在服务可用日期为过去时间时指定了“可用”状态。
    解决方案: 当 Available_Dates 为过去时间时,您不能将服务标记为可用或临时不可用。

  • INVALID_URL_PATTERNHTTP 404

    请检查您是否正在尝试访问正确的URL。
    解决方案: 您提交了一个无效的请求URL。请仅使用/Services__s端点来提供有效的URL。

  • INTERNAL_ERRORHTTP 500

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

示例回复

Copied{
    "data": [
        {
            "code": "SUCCESS",
            "details": {
                "Modified_Time": "2023-03-31T11:39:31+05:30",
                "Modified_By": {
                    "name": "Patricia Boyle",
                    "id": "5545974000000393001"
                },
                "Created_Time": "2023-03-29T14:04:15+05:30",
                "id": "5545974000002183001",
                "Created_By": {
                    "name": "Patricia Boyle",
                    "id": "5545974000000393001"
                }
            },
            "message": "record updated",
            "status": "success"
        }
    ]
}