NUnullplatform
Inbox rules

Reset a built-in inbox rule to default

Changed on

Discards your organization's edits to a built-in inbox rule, so it runs again as nullplatform ships it. It's the same as Reset to default in the UI.

Answers 404 if your organization didn't edit the rule.

delete/communications/inbox_rule/{id}/customization

Request

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

Path parameters

idstring required

The ID of a built-in inbox rule, like deployment.failed.

Response

The built-in rule, with its state in your organization.

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