NUnullplatform
Inbox rules

Read the inbox rule schema

Changed on

Returns the JSON Schema of an inbox rule definition, with every field documented. Use it to validate definitions or to power completion in your editor.

get/communications/inbox_rule/schema

Request

  • Base URL
    https://api.nullplatform.com
  • URL
    https://api.nullplatform.com/communications/inbox_rule/schema
  • Auth
    HTTP bearer

Response

The JSON Schema of an inbox rule definition.

schemaobject

A JSON Schema document describing every field of an inbox rule definition.

Example response

{
  "schema": {
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "required": [
      "id",
      "source",
      "category",
      "severity",
      "audience"
    ]
  }
}

Changes