我可以在 docusign 中使用 API 修改模板的选项卡吗

Question

我可以在 docusign 中使用 API 修改模板的选项卡吗

lin*_*per 2 docusignapi

阅读 API 文档，我了解到我可以编辑创建/发送的信封的收件人选项卡

但是我想了解一下，我还可以修改模板的选项卡吗？

当我使用相同的请求时，如下所示，我收到错误

任何参考将是可观的。

我的问题的原因是，每次当我更新提要文档以进行一些更正时，我都必须重做在其上创建字段。相反，如果我可以通过 API 发送字段，那将节省我很多时间

谢谢

更新选项卡时的示例 JSON（尝试添加选项卡）

{
  "signers": [
    {
      "tabs": {
        "fullNameTabs": [
          {
            "name": "Full Name",
            "tabLabel": "Full Name",
            "bold": "false",
            "italic": "false",
            "underline": "false",
            "documentId": "1",
            "recipientId": "5b46b9dc-d40d-493d-b319-5757bf1d5cb4",
            "pageNumber": "1",
            "xPosition": "321",
            "yPosition": "676",
            "tabId": "82be754a-47c6-47fc-9793-6fdec6758060"
          }
        ],
        "dateSignedTabs": [
          {
            "name": "Date Signed",
            "value": "",
            "tabLabel": "Date Signed",
            "bold": "false",
            "italic": "false",
            "underline": "false",
            "documentId": "1",
            "recipientId": "5b46b9dc-d40d-493d-b319-5757bf1d5cb4",
            "pageNumber": "1",
            "xPosition": "504",
            "yPosition": "676",
            "tabId": "1e3f16e8-77a9-4726-9876-66e6d377a0c1"
          }
        ]
      },
      "signInEachLocation": "false",
      "name": "",
      "email": "",
      "recipientId": "5b46b9dc-d40d-493d-b319-5757bf1d5cb4",
      "recipientIdGuid": "5b46b9dc-d40d-493d-b319-5757bf1d5cb4",
      "requireIdLookup": "false",
      "routingOrder": "1",
      "roleName": "ONE",
      "status": "created",
      "templateLocked": "false",
      "templateRequired": "false",
      "emailNotification": {
        "emailSubject": "Subject",
        "emailBody": "Body",
        "supportedLanguage": "en"
      }
    },
    {
      "tabs": {
        "signHereTabs": [
          {
            "name": "Sign Here",
            "tabLabel": "Signature 3",
            "scaleValue": 0.9,
            "optional": "false",
            "documentId": "1",
            "recipientId": "d4f63c18-8ccc-4ed3-bacb-660bebf829bf",
            "pageNumber": "1",
            "xPosition": "106",
            "yPosition": "591",
            "tabId": "9b20f825-f37c-4dc6-aa57-d29b3d531d6b"
          }
        ],
        "fullNameTabs": [
          {
            "name": "Full Name",
            "tabLabel": "Full Name",
            "bold": "false",
            "italic": "false",
            "underline": "false",
            "documentId": "1",
            "recipientId": "d4f63c18-8ccc-4ed3-bacb-660bebf829bf",
            "pageNumber": "1",
            "xPosition": "319",
            "yPosition": "622",
            "tabId": "79c35daf-cada-4a57-ac82-8a2a149839e8"
          }
        ],
        "dateSignedTabs": [
          {
            "name": "Date Signed",
            "value": "",
            "tabLabel": "Date Signed",
            "bold": "false",
            "italic": "false",
            "underline": "false",
            "documentId": "1",
            "recipientId": "d4f63c18-8ccc-4ed3-bacb-660bebf829bf",
            "pageNumber": "1",
            "xPosition": "504",
            "yPosition": "622",
            "tabId": "14d47f01-a911-49b9-bf04-1c4cadb2924a"
          }
        ]
      },
      "signInEachLocation": "false",
      "name": "",
      "email": "",
      "recipientId": "d4f63c18-8ccc-4ed3-bacb-660bebf829bf",
      "recipientIdGuid": "d4f63c18-8ccc-4ed3-bacb-660bebf829bf",
      "requireIdLookup": "false",
      "routingOrder": "2",
      "roleName": "TWO",
      "status": "created",
      "templateLocked": "false",
      "templateRequired": "false",
      "emailNotification": {
        "emailSubject": "Subject",
        "emailBody": "Body",
        "supportedLanguage": "en"
      }
    },
    {
      "tabs": {
        "approveTabs": [
          {
            "buttonText": "Approve",
            "width": 60,
            "height": 18,
            "tabLabel": "Approve 9",
            "font": "lucidaconsole",
            "bold": "false",
            "italic": "false",
            "underline": "false",
            "fontSize": "size9",
            "documentId": "1",
            "recipientId": "95f1d73e-df27-4f19-86ea-c921f0321d26",
            "pageNumber": "1",
            "xPosition": "228",
            "yPosition": "718",
            "tabId": "5083943e-bdf0-42fe-87ff-d92778b13be7"
          }
        ],
        "declineTabs": [
          {
            "buttonText": "Decline",
            "width": 60,
            "height": 18,
            "declineReason": "",
            "tabLabel": "Decline 10",
            "font": "lucidaconsole",
            "bold": "false",
            "italic": "false",
            "underline": "false",
            "fontSize": "size9",
            "documentId": "1",
            "recipientId": "95f1d73e-df27-4f19-86ea-c921f0321d26",
            "pageNumber": "1",
            "xPosition": "350",
            "yPosition": "718",
            "tabId": "b1c1ad78-e3b9-4630-b411-09127997f7dd"
          }
        ]
      },
      "signInEachLocation": "false",
      "name": "",
      "email": "",
      "recipientId": "95f1d73e-df27-4f19-86ea-c921f0321d26",
      "recipientIdGuid": "95f1d73e-df27-4f19-86ea-c921f0321d26",
      "requireIdLookup": "false",
      "routingOrder": "3",
      "roleName": "THREE",
      "status": "created",
      "templateLocked": "false",
      "templateRequired": "false",
      "emailNotification": {
        "emailSubject": "Subject",
        "emailBody": "Body",
        "supportedLanguage": "en"
      }
    }
  ],
  "agents": [],
  "editors": [],
  "intermediaries": [
    {
      "name": "",
      "email": "",
      "recipientId": "fa2bffdb-81d7-4de4-a964-e543e2d1d3cf",
      "recipientIdGuid": "fa2bffdb-81d7-4de4-a964-e543e2d1d3cf",
      "requireIdLookup": "false",
      "routingOrder": "3",
      "roleName": "FOUR",
      "status": "created",
      "templateLocked": "false",
      "templateRequired": "false",
      "emailNotification": {
        "emailSubject": "Subject",
        "emailBody": "Body",
        "supportedLanguage": "en"
      }
    }
  ],
  "carbonCopies": [],
  "certifiedDeliveries": [],
  "inPersonSigners": [],
  "recipientCount": "5"
}

Run Code Online (Sandbox Code Playgroud)

URL（尝试了 POST/PUT）

https://DOMAIN/restapi/v2/accounts/ACCTID/envelopes/ENVELOPID/recipients

Run Code Online (Sandbox Code Playgroud)

{
  "errorCode": "ENVELOPE_CANNOT_CORRECT_INVALID_STATE",
  "message": "This account may not have 'correct' permission, or the envelope state is not 'sent' or 'delivered'."
}

Run Code Online (Sandbox Code Playgroud)

Answer 1

Kim*_*ndl 5

我不相信可以使用 API 修改模板本身中的选项卡。您尝试使用的“修改或更正收件人信息”操作允许您“修改草稿信封中的收件人或更正处理中信封的收件人信息”。（来自 REST API 指南的 p156：https : //08d1d92f490618f41c65-8fb00e97ac499a7066a18ce9c66b019b.ssl.cf2.rackcdn.com/REST_API_Guide_v2.pdf）。由于模板既不是草稿信封也不是处理中的信封，我不希望此操作适用于修改模板中的标签。

如果您想使用模板来指定文档，然后在每次发送信封时通过“创建信封”API 调用指定字段，您可以使用我在下面描述的技术来实现这一点。（如果您在 Create Envelope API 调用中使用“复合模板”，也可以应用相同的技术。）

例如，假设我通过 DocuSign UI 创建了一个模板，该模板具有单个收件人 (Signer1) 并且文档中没有标签。然后，我可以使用以下请求创建一个信封，其中包含模板定义的文档和收件人，以及我的 API 请求指定的标签（在本例中，只有一个文本选项卡）：

POST https://{{env}}.docusign.net/restapi/{{version}}/accounts/{{acctId}}/envelopes

{
  "emailSubject": "Please sign this",
  "emailBlurb": "Please sign...thanks!",
  "templateId": "TEMPLATE_ID",
  "templateRoles": [
   {
      "roleName": "Signer1",
      "name": "John Doe",
      "email": "johnsemail@outlook.com",
      "recipientId": "1",
      "tabs":{
            "textTabs":[
               {
                 "documentId": "1",
                 "pageNumber": "1",
                 "recipientId": "1",
                 "xPosition": "100",
                 "yPosition": "400",
                 "tabLabel":"Address",
                 "name":"Address",
                 "value":"123 Main Street",
                 "locked": "false"
               },
            ],
         }
    }
  ],
  "status": "sent"
}

Run Code Online (Sandbox Code Playgroud)

上面的示例在“创建信封”请求中使用了templateRoles。如果您在“创建信封”请求中使用复合模板，则请求正文将如下所示：

POST https://{{env}}.docusign.net/restapi/{{version}}/accounts/{{acctId}}/envelopes
{
    "emailSubject": "Please sign",
    "emailBlurb": "Please sign...thanks!",
    "status": "sent",
    "compositeTemplates": [{
        "serverTemplates": [{
            "sequence": 1,
            "templateId": "TEMPLATE_ID"
        }],
        "inlineTemplates": [{
            "sequence": 2,
            "recipients": {
                "signers": [{
                    "email": "sallysemail@outlook.com",
                    "name": "Sally Adamson",
                    "recipientId": "1",
                    "roleName": "Signer1",
                     "tabs":{
                        "textTabs":[
                           {
                             "documentId": "1",
                             "pageNumber": "1",
                             "recipientId": "1",
                             "xPosition": "100",
                             "yPosition": "400",
                             "tabLabel":"Address",
                             "name":"Address",
                             "value":"123 Main Street",
                             "locked": "false"
                           },
                        ],
                     }
                }]
            }
        }]
    }]
}

Run Code Online (Sandbox Code Playgroud)

如果您要实施这种方法，我建议您考虑使用“锚文本”技术来指定标签位置，而不是为每个标签指定 xy 坐标。使用“锚文本”放置技术意味着您指定每个标签相对于文档中某些现有文本的位置，这样标签位置将始终是正确的，即使您的文档格式略有变化——只要因为锚文本字符串仍然存在于文档中，因此可用于放置标签。有关使用锚文本指定标签位置的更多信息，请参阅 REST API 指南的第 324-325 页。

归档时间：	11 年，7 月前
查看次数：	1496 次
最近记录：	9 年，10 月前