DocuSign更新已发送信封时新增/修改自定义文本字段报INVALID_CUSTOM_FIELD_ID错误

错误根本原因 #

你当前传入的fieldId为自定义赋值，不是DocuSign系统为对应信封自定义字段生成的真实唯一ID，或新增字段时主动传入了fieldId参数触发校验失败。

分场景操作方案 #

场景1：更新已存在的自定义文本字段 #

• 先调用获取信封自定义字段的接口，查询目标信封已有的自定义字段列表，获取待修改字段对应的系统生成真实fieldId，该值为数字字符串，不可自定义赋值
• 调用更新接口时传入查询到的真实fieldId，请求示例参考：

{
  "customFields": {
    "textCustomFields": [
      {
        "fieldId": "系统查询得到的真实fieldId值",
        "name": "CreatedByEmail",
        "required": "true",
        "show": "true",
        "value": "dummy@dummy.com"
      }
    ]
  }
}

场景2：新增自定义文本字段 #

• 新增操作不需要也不能传入fieldId参数，该参数由系统自动生成，主动传入任何值都会触发校验错误
• 新增请求示例参考：

{
  "customFields": {
    "textCustomFields": [
      {
        "name": "新增字段名（不可与当前信封已有自定义字段重名）",
        "required": "false",
        "show": "true",
        "value": "自定义字段值"
      }
    ]
  }
}

其他注意事项 #

• 同一请求同时更新信封状态和操作自定义字段不受影响，仅需保证自定义字段参数符合上述规则即可
• 若使用DocuSign.eSign NuGet包操作，新增字段时不要为TextCustomField对象的FieldId属性赋值，更新字段时先查询获取真实FieldId再赋值即可
• 自定义字段名不可包含特殊字符，同一信封内字段名唯一，否则会触发其他参数错误

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