docusignapi - DocuSign：如何将自定义属性附加到信封

Question

您好，我们希望通过 API 将申请号附加到 Docusign 请求（信封）。

我们如何将自定义属性附加到信封，以传递对特定事务的一些引用，因此它是签名完成时在 webhook 中发送回的有效负载的一部分？我们尝试过的如下：

 let recipients = docusign.Recipients.constructFromObject({
   signers: [signer1],
   carbonCopies: [cc1],
   applicationNo: app.id,
 })

 env.recipients = recipients
 env.applicationNo = "someApplicationNumber"
 env.status = args.status

标签： docusignapi

Answer 1

从您的代码示例中，您似乎想要在信封（事务）级别附加元数据。为此，请使用EnvelopeCustomFields

• 您可以创建使用字符串或枚举字符串值。
• 您可以将它们包含在信封定义中。请参见此处，或者您可以为它们使用单​​独的 API 调用
• 如果需要，您可以将它们包含在结业证书中。

将 Node.js SDK 用于名为 EnvelopeCustomField 的示例applicationNo：

    let textCustomField1 = docusign.TextCustomField.constructFromObject({
        name: "applicationNo",  
        show: "true",    // show the field in the certificate of completion
        value: "12345" 
        });
    let textCustomFields1 = [textCustomField1];
    let customFields1 = docusign.CustomFields.constructFromObject({
        textCustomFields: textCustomFields1 
        });
...
    let envelopeDefinition = docusign.EnvelopeDefinition.constructFromObject({
        customFields: customFields1,  
        documents: documents1,  
        emailSubject: "Please sign the attached document",  
        recipients: recipients1,  
        status: "sent" 
        });

JSON中的相同示例：

  "envelopeDefinition": {
    "emailSubject": "Please sign the attached document",
    "status": "sent",
    "customFields": {
      "textCustomFields": [
        {
          "name": "applicationNo",
          "show": "true",
          "value": "12345"
        }
      ]
    },
    "documents": ....

结业证书。

注意applicationNo数据