c# - 使用新的 DocuSign C# 客户端作废信封

Question

我正在尝试使用更新版本的 DocuSign C# Client 使现有信封无效(DocuSign.eSign)。

信封处于已发送状态，尚未完成或作废。

目前我有以下代码:

EnvelopesApi envelopesApi = new EnvelopesApi();

Envelope envelope = envelopesApi.GetEnvelope(accountId, envelopeId);           
envelope.Status = "voided";
envelope.VoidedReason = "This envelope was voided by " + currentUserName;

// create the recipient view (aka signing URL)
var updateSummary = envelopesApi.Update(accountId, envelopeId, envelope);

return updateSummary;

调用此代码时，它会失败并出现 ApiException 和以下 ErrorContent:

{
  "errorCode": "INVALID_REQUEST_PARAMETER",
  "message": "The request contained at least one invalid parameter. Value for 'purgeState' must be 'documents_queued' or 'documents_and_metadata_queued'."
}

消息是“请求包含至少一个无效参数。‘purgeState’的值必须是‘documents_queued’或‘documents_and_metadata_queued’”，但根据文档，如果状态是“无效的”，我有一个无效的理由。

有没有办法使用 DocuSign C# 客户端作废信封？

Answer 1

问题似乎是在加载信封并将其传递给 API 调用时将 envelope.PurgeState 设置为“unpurged”。因此，即使我没有明确设置 PurgeState，它也认为我正在尝试使用无效参数执行清除操作。

我能够通过显式取消设置 envelope.PurgeState 来解决这个问题:

envelope.Status = "voided";
envelope.VoidedReason = "This envelope was voided by " + currentUserName;
envelope.PurgeState = null;