API

エンベロープを無効化するときのAPI動作のアップデート

2025年3月から数か月の間にエンベロープを無効化するAPIの動作が変更され、特に指定がない限り、無効化されたエンベロープが自動的に削除されるようになります。このアップデートにより、APIエンドポイントEnvelopes: updateが影響を受けます。

現在、送信済みのエンベロープを無効化すると、単にそのエンベロープの状態がvoided（無効）に変更されます。

このアップデートにより、送信済みのエンベロープを無効化すると、ステータスがvoidedに変更され、デフォルトで［削除済み］フォルダーに移動されます。無効化したエンベロープを削除しないようにするには、要求パスを使用してrecycle_on_voidクエリ文字列パラメーターを追加します。recycle_on_voidをfalseに設定すると、無効化したエンベロープが削除されなくなります。以下の更新されたAPIコール要求パスを参照してください。要求本文に変更は必要ありません。

/restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}?recycle_on_void=false

このアップデートは、2025年3月以降にデモ環境とすべての実稼働環境に適用される予定です。