Docusign创建信封时如何为收件人添加可在API回调返回的持久自定义信息

完全可以实现你的需求，DocuSign原生支持为收件人配置不对外展示的专属后台元数据，且可配置随Webhook回调返回，具体操作如下：

1. 创建信封时配置收件人自定义字段 #

在调用创建信封接口时，每个收件人对象下添加customFields数组，传入你需要自定义的业务字段即可，该字段为后台专属属性，不会展示给签署人，也不属于需要用户填写的Tab类控件。
示例请求片段：

{
  "signers": [
    {
      "email": "signer@test.com",
      "name": "主签署人",
      "recipientId": "1",
      // 收件人专属自定义字段，可传入任意业务标识
      "customFields": ["our_recipient_type=签署人"]
    },
    {
      "email": "dealer@test.com",
      "name": "经销商",
      "recipientId": "2",
      "customFields": ["our_recipient_type=经销商"]
    }
  ]
}

2. 配置Webhook回调返回自定义字段 #

你需要调整Connect（DocuSign Webhook服务）的配置，开启「收件人自定义字段返回」开关：

• 如果是在DocuSign后台可视化配置Connect，在回调配置项中勾选包含收件人自定义字段即可
• 如果是通过API创建Connect配置，将参数includeRecipientCustomFields设置为true即可
  配置完成后，后续所有触发的回调Payload中，对应收件人的节点下会原样返回你设置的customFields内容，直接解析即可拿到业务侧需要的角色标识，完成业务流程闭环。

补充说明 #

• 单个收件人最多支持配置10个自定义字段，单个字段内容长度上限为100字符，可满足绝大多数业务标识存储需求
• 自定义字段内容仅会在API交互、后台配置中可见，不会透传给收件人，不会对签署流程产生任何影响

内容的提问来源于stack exchange，提问作者Bill in Kansas City