REST - 将收件人添加到信封角色

时间:2014-11-07 01:26:25

标签: docusignapi

我正在尝试将收件人添加到从使用角色的模板('AlliancesDirectoy'和'合作伙伴')创建的草稿信封中。为清晰起见,两个角色都在路由顺序1中,但这无关紧要。

创建信封后,我们可以看到已经使用两个已定义的角色创建了草稿信封。

enter image description here

现在我尝试将收件人添加到我的角色'AlliancesDirector'。

{
    "signers": [
    {
      "email": "mike@xyz.com",
      "Name": "Mike",
      "RecipientId": 1,
      "RoleName": "AlliancesDirector",
    }
  ]
}

导致以下回复: enter image description here

如果我然后查看已添加到信封ID的收件人,请参阅以下内容: enter image description here

当然,当我尝试使用已经使用的“1”的recipientId添加收件人时,这让我相信它不喜欢。例如,如果我将recipientId更改为5,则除了角色之外,还会添加我的收件人。我不想添加角色,我想让用户进入预定义的角色。

希望对我正在努力实现的目标有更详细的解释。

2 个答案:

答案 0 :(得分:1)

这是在创建信封时将收件人添加到模板中。

{
    "emailSubject": "StackOverflow Test",
    "status": "created",
    "templateId": "63611019-753f-41c2-b9fe-6aab8ea26387",
    "templateRoles": [
        {
            "email": "so@emaildomain.com",
            "name": "Stack Overflow",
            "roleName": "Leet Person"
        }
    ]
}

这是将收件人添加到现有信封(无论是否是模板):

{
    "signers": [
        {
            "name": "Stack Overflow",
            "email": "so@emaildomain.com",
            "roleName": "Leet Person",
            "recipientId": 1
        }
    ]
}

与往常一样,请参阅文档Here以获取有关电话的具体指导。

修改或更正并重新发送收件人信息

这使您可以修改草稿信封中的收件人或更正进行中信封的收件人信息。

对于草稿信封,您可以编辑:email,userName,routingOrder,faxNumber,deliveryMethod, accessCode和requireIdLookup。


注意:如果您为草稿信封中尚不存在的收件人发送信息, 收件人将被添加到信封中(类似于POST)。


信封发送后,您只能编辑:email,userName,signerName,routingOrder, faxNumber和deliveryMethod。您还可以使用选择重新发送信封 resend_envelope选项。

<强> URL:

/accounts/{accountId}/envelopes/{envelopeId}/recipients

可选添加:resend_envelope {true或false}

答案 1 :(得分:1)

我花了一些时间来解决这个问题,但终于能够重现你的错误,我相信我知道你做错了什么。根据我对您正在进行的第二个API调用的详细信息的问题,您需要执行Recipient Correction将收件人分配给给定的模板角色,并且当我被错误地收到时,我遇到了同样的错误使用POST方法并认为你也在做同样的事情。

将您的第二个电话从POST更改为PUT,它应该有效。我在测试中验证了这是按预期工作的。