将复合模板发送到 Docusign 时出错 API

Error Sending Composite Template to Docusign API

我正在尝试使用 docusign-node-client 通过 createEnvelope class 发送信封。此 class 向 /envelopes 端点发送 REST API 请求。我要发送的信封包含一个复合模板。

这是我要发送给 docusign 的正文

{
  "emailSubject": "Sent from Node SDK",
  "emailBlurb": "Email body here",
  "customFields": {
    "textCustomFields": [
      {
        "name": "DSFSSourceObjectId",
        "required": false,
        "show": false,
        "value": "dealIdHere"
      }
    ]
  },
  "compositeTemplates": [
    {
      "inlineTemplates": [
        {
          "sequence": "1",
          "documents": [
            {
              "documentBase64": "base64StringHere",
              "documentId": "1",
              "fileExtension": ".pdf",
              "name": "filename.pdf"
            }
          ],
          "envelope": {
            "emailBlurb": "Email body here",
            "emailSubject": "Sent from Node SDK",
            "customFields": {
              "textCustomFields": [
                {
                  "name": "DSFSSourceObjectId",
                  "required": false,
                  "show": false,
                  "value": "dealIdHere"
                }
              ]
            },
            "recipients": {
              "signers": [
                {
                  "email": "myEmail@domain.com",
                  "name": "My Name",
                  "recipientId": "1"
                }
              ]
            }
          }
        }
      ],
      "serverTemplates": [
        {
          "sequence": "1"
        }
      ]
    }
  ],
  "status": "sent"
}

当我发送此正文时出现以下错误:"The request contained at least one invalid parameter. Invalid value specified for \'templateId\' in composite template sequence: 1"

如果删除 serverTemplates 数组,我会收到此错误:"The Envelope is not Complete. A Complete Envelope Requires Documents, Recipients, Tabs, and a Subject Line."

如果我在 serverTemplate 对象中包含一个有效的 templateId,它会成功创建一个信封。

我正在转换为 Node JS 的应用程序使用了 Docusign SOAP API 并且能够发送包含 1 个到多个文档的复合模板。这些文档中的每一个都可以关联到它们自己的文档模板或没有文档签名模板。

如果没有对模板 ID 进行某种引用,docusign 是否不接受复合模板?

您指定的 inlineTemplate.envelope 属性 不正确。您可以直接在内联模板中定义收件人和自定义字段。您不必在 inlineTemplate 中指定 emailSubject/emailBlurb。

另请注意,在使用复合模板时,在根级别指定的自定义字段将被忽略。看到这个

以下 json 应该适合您。

{
    "emailSubject": "Sent from Node SDK",
    "emailBlurb": "Email body here",
    "status": "sent"
    "compositeTemplates": [
        {
            "inlineTemplates": [
                {
                    "sequence": "1",
                    "documents": [
                        {
                            "documentBase64": "base64StringHere",
                            "documentId": "1",
                            "fileExtension": ".pdf",
                            "name": "filename.pdf"
                        }
                    ],

                    "customFields": {
                        "textCustomFields": [
                            {
                                "name": "DSFSSourceObjectId",
                                "required": false,
                                "show": false,
                                "value": "dealIdHere"
                            }
                        ]
                    },
                    "recipients": {
                        "signers": [
                            {
                                "email": "myEmail@domain.com",
                                "name": "My Name",
                                "recipientId": "1"
                            }
                        ]
                    }

                }
            ]
        }
    ]
}