Box Developerドキュメント

BoxWorks 2024でコンテンツとAIの可能性について紹介します。

詳細を表示

通知の抑制

ガイド APIコール 通知の抑制

通知の抑制

一部のAPIコールでは、APIコールにbox-notifications: offヘッダーを指定することで、メール通知およびWebhook通知を抑制できます。

cURL
curl -X POST https://api.box.com/2.0/folders \
    -H "box-notifications: off" \
    -H "authorization: Bearer ACCESS_TOKEN" \
    -d '{
      "name": "New Folder",
      "parent": {
        "id": "0"
      }
    }'

たとえば、これをウイルススキャンツールに使用すると、社内でユーザーのファイルのコピーをダウンロードするたびに、そのファイルのすべてのコラボレータにダウンロードに関する通知メールが届くことはなくなります。

この場合でも、すべてのアクションがユーザーの更新フィードと監査ログに表示されます。

スコープの要件

通知の抑制は、承認されたアプリケーションでのみ使用できます。アプリケーションに対して有効にする必要なスコープをリクエストするには、サポートにお問い合わせください。

この機能を正しく動作させるには、アプリケーションに対して以下の設定を構成する必要があります。

  • [APIコールからメール通知を抑制する] - サポート経由のリクエストで対応可能
  • [Enterpriseのプロパティを管理する] - 開発者コンソールから使用可能
  • [会社の設定を編集する] の共同管理者権限

一部の通知は抑制できません。その代表として、ユーザー、コメント、コラボレーション、タスク割り当ての作成のほか、ユーザーのログインの変更時があります。