使用信封 ID (Assembly DocuSign.eSign) 删除 DocuSign 上的特定文档



我在C#中使用DocuSign.eSign dll。 我想从文档中删除文档(信封)

我使用了"EnvelopesApi"类公开的方法,如"删除文档"。但它本质上是从草稿信封中删除文档,但我想删除在 doccusign 生成的任何信封。

EnvelopeDefinition envelopeDefinition = new EnvelopeDefinition
{
EnvelopeId = envelopId
};
envelopesApi.DeleteDocuments(accountId, envelopId,                                                          
envelopeDefinition);

调用此方法后,我希望文档(信封)从DocuSign中删除,但我仍然可以使用"列表文档"方法检索文档。 请让我知道我错过了什么。

这里有两个选项,所以你可能想澄清你到底在寻找什么。

  1. 删除信封。删除信封实际上不会将其从 DocuSign 系统中删除,它只是删除用户指向它的指针,使其不再出现在他们的"管理"选项卡中。若要删除信封,请使用文件夹 ID 为"回收站"的文件夹::移动信封方法。请注意,如果发件人删除处理中信封,则该信封将作废。

    此示例演示如何删除两个信封:

    FoldersApi foldersApi = new FoldersApi(apiClient.Configuration);
    FoldersRequest foldersRequest = new FoldersRequest();
    foldersRequest.EnvelopeIds = new List<string>();
    foldersRequest.EnvelopeIds.Add("000-111-222");
    foldersRequest.EnvelopeIds.Add("333-444-555");
    foldersApi.MoveEnvelopes(accountId, "recyclebin", foldersRequest);
    
  2. 清除信封。清除的信封将从 DocuSign 中完全删除,仅保留存根记录和结业证书。此处提供了清除的详细信息:https://support.docusign.com/en/guides/ndse-user-guide-purge-envelopes 请注意,清除信封会向具有 DocuSign 帐户的所有收件人发送通知,并且有两周的延迟,以允许他们在删除信封之前访问信封。

    若要将信封排队以进行清除,应使用 Envelopes::Update 方法。通过 SDK 调用此方法时,建议创建一个空的信封对象,在其中设置 PurgeState,然后使用 Update() 方法应用该对象。

    EnvelopesApi envelopesApi = new EnvelopesApi(apiClient.Configuration);
    string envelopeId = "000-111-222";
    Envelope purgeEnvelope = new Envelope
    {
    PurgeState = "documents_queued" //change to "documents_and_metadata_queued" to also remove recipient info
    };
    envelopesApi.Update(accountId, envelopeId, purgeEnvelope); 
    

最新更新