NUnullplatform
Inbox rules

Delete an inbox rule permanently

Changed on

Deletes one of your organization's inbox rules for good, together with everyone's inbox settings for it. This can't be undone.

Deactivate the rule first: an active rule answers an error. Notifications it already sent stay in people's inboxes. To discard your edits to a built-in rule, reset it to default instead.

delete/communications/inbox_rule/{id}/permanent

Request

  • Base URL
    https://api.nullplatform.com
  • URL
    https://api.nullplatform.com/communications/inbox_rule/{id}/permanent
  • Auth
    HTTP bearer

Path parameters

idstring required

The ID of the inbox rule, like acme.security_finding or deployment.failed.

Response

The inbox rule that was deleted.

idstring

The ID of the inbox rule.

organization_idinteger nullable

Your organization's ID for its own rules, or null for a built-in rule.

publisherstring

Who published the rule: organization for your organization's rules.

status'active' | 'deprecated'

Whether the rule is active. deprecated means deactivated.

created_atstring date-time

When the rule was created.

updated_atstring date-time

When the rule was last updated.

Example response

{
  "id": "acme.security_finding",
  "organization_id": 1,
  "publisher": "organization",
  "status": "active",
  "document": {
    "id": "acme.security_finding",
    "status": "active",
    "context_schema": {
      "type": "object",
      "required": [
        "id",
        "service",
        "owner_id"
      ],
      "properties": {
        "id": {
          "type": "string"
        },
        "service": {
          "type": "string"
        },
        "summary": {
          "type": "string"
        },
        "owner_id": {
          "type": "integer"
        }
      }
    },
    "category": {
      "group": "security",
      "label": "Security findings",
      "description": "Vulnerabilities your CI scanners report.",
      "configurable": true,
      "allows_all": true,
      "default_mode": "involved"
    },
    "severity": "degraded",
    "audience": [
      {
        "as": "owner",
        "who": {
          "user": "${{ context.owner_id }}"
        },
        "action": "acme.security_finding",
        "content": {
          "title": "Security finding on ${{ context.service }}",
          "body": "${{ context.summary }}"
        }
      }
    ],
    "visible_to": [
      "organization=1:account=2"
    ]
  },
  "created_at": "2026-10-20T14:03:11.000Z",
  "updated_at": "2026-10-20T14:03:11.000Z",
  "organization_state": {
    "enabled": true,
    "linked": []
  }
}

Changes