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

Question

我正在尝试将收件人添加到一个草稿信封，该信封是从用于角色（“AllianceDirectoy”和“Partner”）的模板创建的。为了清楚起见，两个角色都在路由顺序 1 中，但这无关紧要。

创建信封后，我们可以看到草稿信封已创建并定义了两个角色。

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

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

这会导致以下响应：

如果我然后查看已添加到信封 ID 的收件人，请参阅以下内容：

这自然让我相信，当我尝试使用“1”的已在使用的收件人 ID 添加收件人时，它不喜欢。例如，如果我将接收者 ID 更改为 5，它会添加我的接收者除了角色。除了角色我不想添加，我想把一个用户放到预定义的角色中。

希望对我要完成的工作的更详细说明有所帮助。

Answer 1

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

将您的第二个电话从POST 更改为PUT，它应该可以工作。我已在测试中验证它按预期工作。

Answer 2

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

{
    "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、 传真号码和传递方法。您也可以使用 重新发送信封选项。

网址：

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

可选添加：resend_envelope {true or false}