NUnullplatform
Inbox rules

Turn a built-in inbox rule on or off

Changed on

Turns a built-in inbox rule on or off for your organization, together with the built-in rules linked to it.

A built-in rule that one of your active rules replaces can't be turned on: deactivate your rule first. To turn off one of your own rules, deactivate it instead.

put/communications/inbox_rule/{id}/organization_state

Request

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

Path parameters

idstring required

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

Request body

enabledboolean required

true turns the rule on for your organization, and false turns it off.

Response

The rule and the built-in rules linked to it, each with its new state.

Example response

{
  "results": [
    {
      "id": "deployment.failed",
      "organization_state": {
        "enabled": true,
        "linked": []
      }
    }
  ]
}

Changes