---
id: inbox-rule-state-update
title: Turn a built-in inbox rule on or off
description: >-
  Turns a built-in inbox rule on or off for your organization, together with the
  built-in rules linked to it.
sidebar_label: Turn a built-in inbox rule on or off
hide_title: true
hide_table_of_contents: true
api: >-
  eJztWVlv40YS/iuFfvEMtk07wQyC5ZszB+LFzM7ARyaAx7Ba7JLYMdnNdBctK4L++6K6SUmU5CMJdjELRC+22EddX31VLC0EqWkQ+ZU4tWN3D76tMIhrKTSGwpuGjLMiFxettwEUjFtT0aGxYFa7wVlwHtxkAhPnYe5aD85PlTW/Kz4tgdwUqUQPM0MlUInra6I4qIy9RQ3kwFD21X61J8MdQKUicBbBTZIAVZC5w+64x6ZSBQYolD0gGCNQ6y1qcDYHjXGvIkwn430T4wNlcOHizqj75u1u1mkmN48bAmMDodLZVyukcA36aOGpFrmIDjnkU4eBFGHeNloRCika5VWNhJ7dvBCG/dkoKoUUVtXIZ7WQwuNvrfGoRU6+RSlCUWKtRL4QNG94VyBv7FRIURv7Ae2USpF/J0Wt7lffvj9e7kSuRDh9y6btjZ6EytwijDQ2lZvXaCmbKFOhHmVCCrxXdVOx8J11sbxOOmOgH52es6LbJhTOElriJdU0lSmiu45+DazZYtdCN/4VCxr44kqgVWOWdy1F49nnZDDwoX5hfX7sXIWKYzP0wYjVGcVYh4i/HrcPAFZZDaOJqsLqkCEGycAlcX0ZP1IELFpvaB4jPEbl0Z+0HJKr6+Sn0Dgbkt7fHx/zn90wRa1Y9hMpIgFVUaZsMhTA4gwi5li/P+3zoXM9hraisLFRea/mQgpDWIenLzB6H3QfwuaOxU+iT4rNmN1E+6NEQ/HIp43Vc0qZuK3xUJtPtpozKIaez6F0szVoAimrAxi7i5tsxwfPR+iXMjHkSo4JD+Jz4BpG9lKKog3kavP7HxK2czOgNoR6pcUevEuRkPgMYHRB32GkH4fIjtyeaNhG9DMbb5eM6I6hPlfXS06sSP36ZjzfBzfbVhWHoCekh+C3rgxJG3UbFUtSDwJEIRLMBJSdD7RgCcv1R4pXv/zyQHYnroTCtZXu6lTjXYEhoM7gvfPQ3SpBwapoMBKMvVOV0TIFBoNrfYGgHQa+B+9NIAkJKqAdPyvVHUKDvjYhMGSANRg7PefrFMsdV1iDRlKmCpAyAl6cvX8D/3z1+oeXjzBJd/YfTzPK0Adv47cxBpixj2doCWbe2amEiasqNzN2Gg3sldjRcuJ8rSjbqg9RquzyXgomgjbsVouk3FOMdAKXZ6cJBEajJTMxmErGrYnQ7JXK4JQOAii73uclWEegIlenImJ4D58OqkbAO/RzIFNjwlZvnyuK1och47XeRmw1lSK2O0fvnc+9awnDYYlVgz7vcHEYwRI40zr2e9rMUDpPEsq2VvbQo9KcJhDaulZ+3jNyb+tAs4sSPYLy2MNyjdXIWbTGOmvUxWOtkrGEU/R7i8FPFxefIZ2AwmnsFenr50CTV8fc7fC2ZxlMbKGEWhWlsbi2OTo2SsvgMsQ2jxyUymp2SIOFmZgi7VrzfjQidX9bgTv7dHnx7vzmp3cfPr87y07//fPJh9O3N59Pzk4+nicuZDD/cbL66KLHUw4wV6uxa2k7l1jBiK0uAhJmJVpQd8rEu3e5S4pk2h5C3y6PCGjJz5lXVrGfGKw0c88KBBnEQtp4DKyWsxB3dgUmysqe30bE+5/XSXAz3QPmEfUG0dogthsTuwpjn5b2JaYAy0n3z1QANjaHEXPsSMLotxY9/+M8jFJ6juAFd/0b2fJyqEs8ElUIoX0Gpr+UiuklxX31ahU1khDaogQVYNRT5Siq0vllq7nvnrLsO1Ul2bv+jUuJG3uDO3h5rPBOWRreah0dqkPb1mP0fHWNIajps5J1i5bwvqmUTQjqA8w+ykSquY/e3HgsFK1fSoayzhk0yTL2VuTPkYRbbCh2X2NV3M6U11C4ulFkxqYyNE9M0e2OjmX+GK3eD/8KYZJXBZ4+A/Mnm7UnKvto5sOpLapWR4KLS9wtcI1XBcFmqYHQNo3zlLzL/n29r6c5dzVSyUV7g36cHVx1ECAYJta/24//r/YjFpd8XCl7+z9qKz65JmQZr3uM/MK2WUJvVZXKxn+3m3j9zXQT32ST8G1T7PPA880xa/QrlY7nh00bmx+eC+biqHB13dqO88JRnNfd8Avq0cLo5dGe0QfPoPxdP2RsfSVyURI1IT86Uo3JNvXIClfH+V0/tjpnEk1EtTm8WvmJLxLdSDJOFuImIbt/3ke8iVz868uFYKuYnM/Ws8F3faA2RiL9OIHRygusevL+d9lxdryi1Fy8GfhiJ1gflVVT7Lq+1Qg7kajGwmhM+Pc8NMOQZmcN+uDsQeiOmGHZktzcaKZTztYkFybe1evx8IaoxLVNO65MKEFZ61pbIA+rQlwZXqONx4KqeczzxgWqVaxj3SiYB+1Pzdm3XbBY18q/B/V7BvUdiAnv6aiplLHs+pghiy7hrkSxDbJ1ygkp8jih35N111KULhDfsFiMVcBLXy2X/Dh18/nVNffU3iTOvloIbcJmBjwSyhdnXZvxEv7SEH+v+f2rnuUXva7pF0KKW5ynHySWPF4rUWn0Ue+08CZpd3iRup7+4M6keSn7EydFgQ09uvd6gwY/X14wrXQ/KNSxHAuvZtx1qVnS0TUpSDym5mcLUSk7bWN5EulKJiE15LAtzopG7fXCYpF2XLhbtMvlyinE39kvy+V/AGtJkbc=
sidebar_class_name: put api-method
info_path: docs/api/communications
custom_edit_url: null
canonical: 'https://docs.nullplatform.com/docs/api/inbox-rule-state-update'
---
<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Turn a built-in inbox rule on or off"}
>
</Heading>

<MethodEndpoint
  method={"put"}
  path={"/communications/inbox_rule/{id}/organization_state"}
  context={"endpoint"}
>

</MethodEndpoint>

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.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"in":"path","name":"id","required":true,"schema":{"type":"string","minLength":1,"maxLength":120},"description":"The ID of a built-in inbox rule, like `deployment.failed`.","example":"deployment.failed"}]}
>

</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"`true` turns the rule on for your organization, and `false` turns it off.","example":false}}}}}}}
>

</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"The rule and the built-in rules linked to it, each with its new state.","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the built-in rule.","example":"deployment.failed"},"organization_state":{"title":"OrganizationState","type":"object","description":"Only on built-in rules: how the rule stands in your organization.","properties":{"enabled":{"type":"boolean","description":"Whether the rule is on for your organization.","example":true},"customized":{"type":"boolean","description":"Whether your organization edited the rule.","example":false},"linked":{"type":"array","items":{"type":"string"},"description":"Built-in rules that turn on and off together with this one.","example":[]},"replaced_by":{"type":"string","nullable":true,"description":"The ID of your rule that takes this one's place, if any.","example":null}}}}}}}}}}},"4XX":{"description":"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).","content":{"application/problem+json":{"schema":{"type":"object","description":"Describes what went wrong, following the RFC 9457 problem details format.","required":["type","title","status"],"properties":{"type":{"type":"string","description":"A URI that identifies the kind of problem. It's an identifier, not a link, and it's the same every time this problem occurs.","example":"urn:nullplatform:error:routes-helper:invalid-params"},"title":{"type":"string","description":"A short, human-readable summary of the problem.","example":"There are invalid parameters on the request"},"status":{"type":"integer","description":"The HTTP status code of the response.","example":400},"code":{"type":"string","description":"A stable, machine-readable error code. Use it to handle specific errors in your integrations.","example":"ROUTES_HELPER.INVALID_PARAMS"},"detail":{"type":"string","nullable":true,"description":"More information about what went wrong in this request, when available.","example":null},"errors":{"type":"array","description":"One entry per invalid field or parameter. Only present on validation errors.","items":{"type":"object","properties":{"field":{"type":"string","description":"The name of the invalid field or parameter.","example":"application_id"},"in":{"type":"string","description":"Where the field was sent: `body`, `query`, or `params` (path parameters).","example":"query"},"issue":{"type":"string","description":"What's wrong with the field, such as `required` or `invalid`.","example":"invalid"},"value":{"description":"The value that was sent, when relevant.","example":"not-a-number"},"message":{"type":"string","description":"A human-readable explanation of the issue."}}}},"message":{"type":"string","deprecated":true,"description":"Same value as `title`, kept for backward compatibility. Use `title` or `code` instead.","example":"There are invalid parameters on the request"},"traceId":{"type":"string","description":"An identifier for this request, when available. Include it when you contact nullplatform support."}}}}}},"5XX":{"description":"Something went wrong on nullplatform's side. The body is a problem details object (RFC 9457).","content":{"application/problem+json":{"schema":{"type":"object","description":"Describes what went wrong, following the RFC 9457 problem details format.","required":["type","title","status"],"properties":{"type":{"type":"string","description":"A URI that identifies the kind of problem. It's an identifier, not a link, and it's the same every time this problem occurs.","example":"about:blank"},"title":{"type":"string","description":"A short, human-readable summary of the problem.","example":"Oops.. there was an internal error"},"status":{"type":"integer","description":"The HTTP status code of the response.","example":500},"code":{"type":"string","description":"A stable, machine-readable error code. Use it to handle specific errors in your integrations."},"detail":{"type":"string","nullable":true,"description":"More information about what went wrong in this request, when available.","example":null},"message":{"type":"string","deprecated":true,"description":"Same value as `title`, kept for backward compatibility. Use `title` or `code` instead.","example":"Oops.. there was an internal error"},"traceId":{"type":"string","description":"An identifier for this request, when available. Include it when you contact nullplatform support."}}}}}}}}
>

</StatusCodes>