---
title: "Turn a built-in inbox rule on or off"
method: PUT
path: "/communications/inbox_rule/{id}/organization_state"
tags: ["Inbox rules"]
---

# Turn a built-in inbox rule on or off

`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

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.

## Path parameters

- `id` string, required

## Request body

- object
  - `enabled` boolean, required: `true` turns the rule on for your organization, and `false` turns it off.

## Response `200`

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

- object
  - `results` object[]
    - `id` string: The ID of the built-in rule.
    - `organization_state` OrganizationState: Only on built-in rules: how the rule stands in your organization.
      - `enabled` boolean: Whether the rule is on for your organization.
      - `customized` boolean: Whether your organization edited the rule.
      - `linked` string[]: Built-in rules that turn on and off together with this one.
      - `replaced_by` string, nullable: The ID of your rule that takes this one's place, if any.

## Other responses

- `4XX`: The request couldn't be processed. For example, a parameter is invalid, the resource doesn't exist, or you don't have permission. The body is a problem details object (RFC 9457).
- `5XX`: Something went wrong on nullplatform's side. The body is a problem details object (RFC 9457).

## Changes

- **2026-10-27** `c0f507ec6087`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/nullplatform/apis/nullplatform-api/changes/communications/inbox_rule/:id/organization_state/put.md)

---

[API](https://skmtc.dev/nullplatform/apis/nullplatform-api.md) - [All operations](https://skmtc.dev/nullplatform/apis/nullplatform-api/llms.txt) - [OpenAPI document](https://skmtc.dev/nullplatform/apis/nullplatform-api/revisions/d3f66bc633d4?raw)