Clio API技术问询：如何正确用PATCH更新事务自定义字段值

我之前刚好踩过这个坑，成功搞定了Clio API更新事务自定义字段的操作，给你梳理下关键要点：

• 必须用custom_field_id而非字段名：这是最容易犯的错误！自定义字段的更新不能直接用字段名称，必须指定该字段的唯一ID，而且要把每个要更新的字段放在custom_field_values数组里，每个元素包含custom_field_id和value两个键。正确的请求体格式如下：

  {
    "data": {
      "custom_field_values": [
        {
          "custom_field_id": "你的自定义字段ID",
          "value": "要设置的新值"
        }
      ]
    }
  }
  

• 匹配字段类型的value格式：不同类型的自定义字段对value的格式要求不同，格式不匹配也会触发422错误：

  • 文本/数字字段：直接传对应字符串或数字即可
  • 下拉选择字段：必须传选项的ID，而不是选项的显示文本
  • 日期字段：要传ISO标准格式的字符串，比如"2024-05-20"
  • 布尔字段：传true或false（注意是JSON布尔值，不是字符串）

• 混合更新默认字段和自定义字段：如果需要同时更新location这类默认字段和自定义字段，可以把它们放在同一个data对象里，示例如下：

  {
    "data": {
      "location": "Orange",
      "custom_field_values": [
        {
          "custom_field_id": "12345",
          "value": "Updated VIP status"
        }
      ]
    }
  }
  

• 验证结构的小技巧：如果拿不准格式，可以先调用GET请求获取目标事务的详情，查看返回结果里custom_field_values的结构，完全照着这个结构来构造PATCH请求体，基本不会出错。

内容的提问来源于stack exchange，提问作者Patrick Sharooz