ドキュメント本文へスキップ
API

ファイルを一括削除する

1 回の呼び出しで最大 100 件のファイルを、`DELETE /files/{id}` が 1 件を削除するのと同じ方法で削除する。「ファイル」ページで複数を選んで削除するのと同じである。

POSTapi.openemail.uk/files/batch-delete

実際の呼び出しを、ご自身のキーで自分のワークスペースに対して実行します。

POST /files/batch-delete

1 回の呼び出しで最大 100 件のファイルを、DELETE /files/{id} が 1 件を削除するのと同じ方法で削除する。「ファイル」ページで複数を選んで削除するのと同じである。

threads:write が必要。ids はファイル id を 1 から 100 件受け取り、それ以外のフィールドは 422 unknown_parameter になる。

curl
curl -X POST "$OE/files/batch-delete" -H "$AUTH" -H 'content-type: application/json' -d '{  "ids": ["file_0c4e7a91d2b84f63a5e19b7d", "file_6bb640f5b99e47deb758f1f5", "file_9e2b41c7a0f35d8e6b1c4a72"]}'
レスポンス
{  "object": "file_batch_delete",  "deleted": ["file_0c4e7a91d2b84f63a5e19b7d"],  "kept": [    {      "id": "file_6bb640f5b99e47deb758f1f5",      "filename": "invoice-0912.pdf",      "usage": "received",      "reason": "It came in on a message, so it stays with that message."    }  ],  "missing": ["file_9e2b41c7a0f35d8e6b1c4a72"]}

一部のファイルが削除され、ほかが残る呼び出しはエラーではない。deleted は削除したもの、kept は使用中の各ファイルとその usage と文章の reasonmissing は不明な id、削除済みの id、限定されたキーが持つアドレスの外にある id を列挙する。

各ファイルは削除する瞬間にもう一度確認されるので、一覧を取った後に使われ始めたファイルは失われずに残る。元に戻す手段はない。