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

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

问题描述:

我正在尝试使用REST API发送一个收件人为签名组的信封。

I am trying to send an envelope with a recipient being a Signing Group using the REST API.

以下是我发布的示例XML代码:

Here is example XML code that I POST:

<?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的电子邮件,所以收到错误消息收件人的电子邮件地址无效。收件人ID紧随其后。

So for Template Role #1 I am trying to assign Test Signing Group to Test Role Name and for Template Role #2 I am able to assign the Standard Role to Non Signing Group with the email being test@example.com. Because I excluded the email for Template Role #1 I get an error message of "The email address for the recipient is invalid. The recipient Id follows."

我想知道我应该如何分配字段,因为签名组是用于多个电子邮件的可能签名。

I am wondering how am I suppose to assign the fields because a signing group is for multiple emails to possibly sign.

我想使用API​​将签名组设置为收件人是因为根据变量,我将更改分配给模板角色#1的签名组,该签名组是在较早的外部过程中确定的。

The reason I want to use the API to set the signing group as the recipient is because depending on variables I will change what signing group is assigned to Template Role #1 which is figured out in an earlier external process.

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

If you specify the signingGroupId, then name/email@ does not become required. You will need to use the ID of the group not the name. You can query the signinGroupId's from the /accounts/{accountId}/signing_groups endpoint.

示例更新到信封创建调用:

Sample update to envelope creation call:

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

文档参考文献:signingGroupId:

Documentation reference re: signingGroupId: