Skip to content

NotificationPreferenceRuleInput

All wire models

Model aliases: NotificationPreferenceRuleInput.

Type: object.

Fields

Required means the key must be present. Nullable means its value may be null; it does not make a required key optional. “Not specified” means the schema declares no default.

Field Type Required Default
kind string Yes Not specified
inbox boolean Yes Not specified
email boolean Yes Not specified

Model constraints

  • Additional properties: not permitted

Field constraints

kind

  • Allowed values: "invitation", "access_granted", "role_changed", "access_removed", "security", "welcome", "digest"

Exact JSON Schema

This is a schema definition, not an example request. It preserves all declared keywords, including constraints not summarized above.

Complete JSON Schema
JSON
{
  "additionalProperties": false,
  "properties": {
    "kind": {
      "enum": [
        "invitation",
        "access_granted",
        "role_changed",
        "access_removed",
        "security",
        "welcome",
        "digest"
      ],
      "title": "Kind",
      "type": "string"
    },
    "inbox": {
      "title": "Inbox",
      "type": "boolean"
    },
    "email": {
      "title": "Email",
      "type": "boolean"
    }
  },
  "required": [
    "kind",
    "inbox",
    "email"
  ],
  "title": "NotificationPreferenceRuleInput",
  "type": "object"
}