使用 REST API 在现有模板中插入文本字段答案

【问题标题】：Insert a text field inside existing template using REST API使用 REST API 在现有模板中插入文本字段
【发布时间】：2021-12-17 23:59:45
【问题描述】：

我正在尝试使用 REST API 将文本字段插入到现有的 DocuSign 模板中，我想知道如何做到这一点。我检查了 TemplateDocuments:update 它使用 API 发送 PUT 请求的位置，但我假设此请求更改了模板中的所有文本选项卡。如果有人可以帮助我在现有模板中插入一个文本字段而不更改其他已经存在的字段，是否有可能？

【问题讨论】：

您是要更改模板还是从模板创建的信封？在这两种情况下，我建议您首先尝试从 Web 应用程序执行此操作，而不使用 API，并生成 API 日志，这些将显示 Web 应用程序的功能（它也使用 REST API）
欢迎来到stackOverflow！ 请检查（接受）您问题的最佳答案。谢谢！

标签： docusignapi docusigncompositetmplts

【解决方案1】：

是的，您可以在调用 Envelopes:create 时向现有模板添加文本字段。通过复合模板执行此操作。

关键是在模板中包含正确文档的documentId 属性。您还需要指定页码、x 和 y 信息。

确定文档 ID

模板的第一个文档的 ID 通常为 1。要查看文档的 ID：

打开模板进行编辑
点击查看感兴趣的文档
在文档的模态显示中：打开浏览器的菜单并选择“在新选项卡中打开图像”
检查新标签的 URL。 /documents/ 后面的数字是文档 ID。例如 URL .../documents/456/pages/... 的文档 ID 为 456

示例

这是一个添加文本字段和列表（下拉）字段的示例。文本字段为locked（不可编辑）。它用作新列表字段的标签。

  "envelopeDefinition": {
    "status": "sent",
    "compositeTemplates": [
      {
        "compositeTemplateId": "1",
        "serverTemplates": [
          {
            "sequence": "1",
            "templateId": "f4e5bdd4-xxxx-xxxxx-xxxx-5fd6b1ebe2fc"
          }
        ],
        "inlineTemplates": [
          {
            "sequence": "1",
            "recipients": {
              "signers": [
                {
                  "email": "name@example.com",
                  "name": "Signer Name",
                  "roleName": "signer",
                  "recipientId": "1",
                  "tabs": {
                    "textTabs": [
                      {
                        "documentId": "1",
                        "locked": "true",
                        "value": "Added via the API. Office:",
                        "font": "Helvetica",
                        "fontSize": "Size12",
                        "pageNumber": "3",
                        "xPosition": "40",
                        "yPosition": "428"
                      }
                    ],
                    "listTabs": [
                      {
                        "documentId": "1",
                        "font": "Helvetica",
                        "fontSize": "Size12",
                        "locked": "false",
                        "required": "false",
                        "pageNumber": "3",
                        "xPosition": "190",
                        "yPosition": "428",
                        "listItems": [
                          {
                            "text": "San Francisco",
                            "value": "SF"
                          },
                          {
                            "text": "London",
                            "value": "LON"
                          },
                          {
                            "text": "Paris",
                            "value": "PAR"
                          },
                          {
                            "text": "Jerusalem",
                            "value": "JLM"
                          },
                          {
                            "text": "São Paulo",
                            "value": "SP"
                          }
                        ]
                      }
                    ]
                  }
                }
              ]
            }
          }
        ]
      }
    ]
  }

【讨论】：