如何在DocuSign模板的签署人区域添加自定义字段？

直接修改signers节点的预定义JSON属性没用，因为这些是DocuSign系统固定的签署人属性。要添加自定义字段，得用自定义标签或收件人自定义数据的方式，分两种场景操作：

一、模板后台可视化配置（适合固定展示的字段） #

• 登录DocuSign后台，打开目标模板的编辑页
• 从左侧工具栏拖**文本标签（Text）**到签署人对应的信息区域
• 编辑标签属性：
  • 把标签类型设为「收件人自定义」
  • 指定关联的签署人角色（要和你模板里的roleName完全匹配，比如你代码里的"verification Code"）
  • 字段名称填"Location"，按需设置显示名称、必填规则
• 保存模板，后续用该模板创建信封时，这个字段会自动绑定到对应签署人

二、API方式动态添加（适合灵活控制的场景） #

不要在signers顶级节点加自定义属性，而是在签署人对象里新增customFields子节点，示例代码如下：

"signers": [
  {
    "accessCode": "", 
    "agentCanEditEmail": "false", 
    "agentCanEditName": "false", 
    "completedCount": "0", 
    "defaultRecipient": "false", 
    "deliveryMethod": "email", 
    "email": "", 
    "inheritEmailNotificationConfiguration": "false", 
    "name": "", 
    "note": "", 
    "recipientId": "1", 
    "recipientIdGuid": "00000000-0000-0000-0000-000000000000", 
    "recipientType": "signer", 
    "requireIdLookup": "false", 
    "roleName": "verification Code", 
    "routingOrder": "1", 
    "signInEachLocation": "false",
    // 新增自定义字段部分
    "customFields": {
      "textCustomFields": [
        {
          "name": "Location",
          "required": "true", // 设为true强制签署人填写
          "show": "true",     // 设为true才会在签署界面显示
          "value": ""         // 留空让签署人填写，或预先赋值
        }
      ]
    }
  }
]

• 如果是修改模板的API定义，要调用Update Template接口，确保模板处于可编辑状态
• 注意roleName必须和签署人角色完全匹配，否则字段不会绑定到正确的签署人

三、常见错误排查 #

• 不要直接在signers顶级节点加自定义属性（比如"Location": ""），这些属性不会被DocuSign识别
• 检查API权限，确保拥有修改模板或创建信封时添加自定义字段的权限
• 确认customFields里的show属性设为"true"，否则字段不会在签署界面显示

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