DocuSign 使用 REST API 将签名组设置为收件人

Question

我正在尝试使用 REST API.

发送收件人为签名组的信封

这是我 POST:

的示例 XML 代码

<?xml version="1.0" encoding="UTF-8"?>
<envelopeDefinition xmlns="http://www.docusign.com/restapi">
   <accountId>xxxxxx</accountId>
   <status>sent</status>
   <emailSubject>xxxxxxxxxxx</emailSubject>
   <templateId>xxxxxx-xxxx-xxxx-xxxxx-xxxxxxx</templateId>
   <templateRoles>
      <templateRole>
         <name>Test Signing Group</name>
         <roleName>Test Role Name</roleName>
      </templateRole>
      <templateRole>
         <name>Non Signing Group</name>
         <roleName>Standard Role</roleName>
         <email>test@example.com</email>
      </templateRole>
   </templateRoles>
</envelopeDefinition>

因此，对于模板角色 #1，我正在尝试将测试签名组分配给测试角色名称，对于模板角色 #2，我可以将标准角色分配给非签名组，电子邮件为 test@example.com.因为我排除了模板角色 #1 的电子邮件，所以我收到 "The email address for the recipient is invalid. The recipient Id follows."

的错误消息

我想知道我应该如何分配字段，因为一个签名组是供多封电子邮件签名的。

我想使用 API 将签名组设置为收件人的原因是，根据变量，我将更改分配给模板角色 #1 的签名组，这在之前的外部进程。

Answer 1

如果您指定 signingGroupId，则 name/email@ 不会成为必需项。您将需要使用组的 ID 而不是名称。您可以从 /accounts/{accountId}/signing_groups 端点查询 signinGroupId。

信封创建调用的示例更新：

  <templateRole>
     <signingGroupId>12345</signingGroupId>
     <roleName>Test Role Name</roleName>
  </templateRole>

Documentation 参考回复：signingGroupId：

DocuSign 使用 REST API 将签名组设置为收件人

DocuSign using REST API to set Signing Group as a recipient

docusignapi