Docusignapi 如何删除或弃用已完成的信封

我有以下情况：

• 发送方“S”通过API为接收方1“R1”和接收方2“R2”创建信封
• R1和R2签名，信封“E1”完成
• 系统中的某些条件发生变化，这会导致S向R1和R2发送一个新信封，其中当然包含更新的文档
• R1和R2签名，第二个信封“E2”完成

在这种情况下，E2应该反对甚至删除E1。问题是R2需要审查他已经签署的所有文件，而且E1和E2都在完整的文件夹中令人困惑

---

据我所知，作废一个完整的信封是不可能的。理想情况下，我想为S找到一种方法，将E2移动到R2帐户的回收站。

您应该能够使用“移动信封””操作删除信封，如REST API指南第174页所述（）。根据指南对移动信封操作的描述：

“这可用于通过使用“recyclebin”作为folderId删除信封。”

更新（示例） 场景#1:

• S1（发件人）将信封发送给1个收件人——R1（收件人#1）
• S1和R1都是同一DocuSign帐户中的成员。(修订) “API用户”——即充当“认证”用户的用户 对于所有API请求，也是同一Docusign的成员 如果在您的场景中，“发送方”在所有API请求中充当“授权”用户，那么“API用户”不一定需要单独的用户/成员身份
• R1在信封上签名。（信封现在已完成。）

操作A:API请求将发件人的信封副本移动到其删除的文件夹中。

PUT https://demo.docusign.net/restapi/v2/accounts/{{acctId}}/folders/recyclebin
X-DocuSign-Authentication: {"SendOnBehalfOf":"SenderS1_email@gmail.com","Username":"APIUser_email@outlook.com","Password":"APIUser_Password","IntegratorKey":"IntKey"}
{ 
 "envelopeIds": ["B547562E-5CFC-4989-913E-501CD88F1506"]
}

PUT https://demo.docusign.net/restapi/v2/accounts/{{acctId}}/folders/recyclebin
X-DocuSign-Authentication: {"SendOnBehalfOf":"RecipientR1_email@gmail.com","Username":"APIUser_email@outlook.com","Password":"APIUser_Password","IntegratorKey":"IntKey"}
{ 
 "envelopeIds": ["B547562E-5CFC-4989-913E-501CD88F1506"]
}

请注意，在请求的X-DocuSign-Authentication头中：

• “验证”用户凭据（用户名，密码） 对应于在该范围内具有帐户范围API权限的用户 帐户

• SendOnBehalfOf的值对应于发件人的成员资格 同一DocuSign帐户中的电子邮件地址，并指定 要采取行动的账户

• 如果发件人的凭据被用作“授权” 如果API请求中包含用户，则不需要包含 X-DocuSign-Authentication标题中的SendOnBehalfOf属性

结果： 当S1登录到DocuSign web控制台时，他看到信封现在位于他的“已删除”文件夹中

操作B:API请求将收件人的信封副本移动到其删除的文件夹中。

PUT https://demo.docusign.net/restapi/v2/accounts/{{acctId}}/folders/recyclebin
X-DocuSign-Authentication: {"SendOnBehalfOf":"SenderS1_email@gmail.com","Username":"APIUser_email@outlook.com","Password":"APIUser_Password","IntegratorKey":"IntKey"}
{ 
 "envelopeIds": ["B547562E-5CFC-4989-913E-501CD88F1506"]
}

PUT https://demo.docusign.net/restapi/v2/accounts/{{acctId}}/folders/recyclebin
X-DocuSign-Authentication: {"SendOnBehalfOf":"RecipientR1_email@gmail.com","Username":"APIUser_email@outlook.com","Password":"APIUser_Password","IntegratorKey":"IntKey"}
{ 
 "envelopeIds": ["B547562E-5CFC-4989-913E-501CD88F1506"]
}

请注意，在请求的X-DocuSign-Authentication头中：

• 再次“验证”用户的凭据（用户名，密码） 对应于在该范围内具有帐户范围API权限的用户 帐户
• SendOnBehalfOf的值对应于同一DocuSign帐户中收件人的成员电子邮件地址，并指定要处理的帐户

结果： 当R1登录到DocuSign web控制台时，她看到信封现在位于她的“已删除”文件夹中

---

注意：如上所述的“移动（删除）信封”操作的最关键部分是对每个API请求的用户进行“身份验证”（X-DocuSign-Authentication标题中的用户名和密码）必须是与正在对其帐户进行操作的用户相同的DocuSign帐户的成员（即，与X-DocuSign-Authentication标题中的SendOnBehalfOf相对应的成员身份）

更新了答案以包含更多信息，包括代码示例。我成功地通过web api删除了此文档。我得到200个代码作为OK状态。但我可以通过我以前在邮件中收到的链接访问该文档。它是否未完全从DocuSign存储库中删除？删除邮件文件夹中的信封每天自动删除一次（通过DocuSign批处理），因此我希望您删除的邮件在您将其移动到“删除邮件”文件夹和清除“删除邮件”文件夹之间的过渡时间内可用（通过DocuSign的批处理）。从DocuSign的支持论坛（）：“删除信封时……它将被发送到“已删除邮件”文件夹，并且只能在当天午夜前访问。”