--- id: inbox-rule-update title: Update an inbox rule description: >- Replaces the definition of one of your organization's inbox rules. Send the whole definition: fields you leave out are removed. sidebar_label: Update an inbox rule hide_title: true hide_table_of_contents: true api: >- eJztXOFy40ZyfpUu1FXJ3oMoarOOK6xyqnTedawre3dL0t5eIm3EIdAk5gTM4GYGpGgW/93/e53kdfICeYVU9wwIgIQkynZcmwr3z4oEMNPT0/1199cDriInZjYaXUfnaqLvwVQ52uhTHKVoEyNLJ7WKRtEFlrlI0ILLEFKcSiXpCugpaIX031JXBrSZCSV/EnTtyIJshhzAJaqUH19kOm8PMoKpxDy1NATkKOYIunIgDILBQs8xHdyoG3WVIYxlOgapeJiJTpdQVNZBIVyS8XckS7hcCpcN4E0qnVQzECwFKJyjgSQTaoYWlHZyKhOWllYmHCzQIIjcoEiXYFG5wY2K4kiXaPi28zQaRbysYxpwVJWpcBjFUSmMKNChIV2uIklKIxGiOFKiQHoqjeLI4F8raTCNRs5UGEc2ybAQ0WgVuWVJd1lnpJpFcVRI9QOqmcui0WkcFeJ+8+nlcL29PaSb89e0DbT0Ru0x5PIOYSySAgcWk8pIt7ydSpVKNRuDNjBOscz1sqClToXMMR0PojjCe1GUOQnU+2i0jsMa/1qhWTaLTM3y1lSqs9KpyO2jS0VVFWSBpJIojvj+6NPOIi/RgdMwptvG9JepFNCGLiHJMLmjxRbSkdkleZViGsNCuoxsyYo5W4FaukyqWXeFPO36kxcZrfuDTpck5vZeJVo5VI4uibLMg+Gc/MWSdKv2+qTjgdmjLqocX29sPYrr1evJXzBxUd9Odv1LqNaGDoBuKIRUtdOQm+TSOkwhQ4MD+E6boBW+Iw7qoPUnWqU8ro0hxVwsbQxCpTAhB5JqFgMZPtuQXw1MjS5g/C9vruAk0UVRqdpdTlimW5LpxN879q7SaO3am7zVlUloXxPhcKbZWiwJKB39KapUokqQMEekXjyRvzfkck6irbVftr5Z0cg9hlQK59CQGv/9Whz/dPvp9zc3g/DX73ZU/YNeoEmERVhok1o2FsB7kbh8yUiSajeAcwcitxpkiorgImAgw4mst8aiI5gJ6pQOEqGOXAAayIVDwxj2z/Bff/vP//6Pv8OLF2+1w9GLFzS+v9k6YZwXYlzmwk21KQbjAXywHsAmlczdsVQ89ZElf8eUzJ2Bi+WZarOLw35bnnboyDrhKvuYg4rEyTmyIkuDtJ/pbqj4mKHL0LS0ZME/OIDXOBVVTjJrAiX6cjxgDArDjaFAoSykyFfpq204YhHWG7sarXbmFxQS7tobNZUGR7QBxzBewU10J1V6E43gJpJqru8wvYlgPR555SU6RUhEnvsBsJDWki+iSkstOSQcwxn4+YGAr4bZm6hB05toPPLPKyfdchN0vJbJdFSV55uNhkvEpx2NpxwPetZhncjxJophMBjwUoSqZ7ZOLHlCUU9OduK0hlyrWQhwCt9NOXJ1955wfhuwHvZSAtHNVq1YOg6XrOJovQ4Yeu9ud4LBHqNvG9oZ/PHy3Vu4DEilvcmlwglAkWQUvlNIhDGS0o8z8lUWxJsEZw4BrDiviGGCiags8oMeWGWKRakJ9WGyBOk6trgr+y72oZlLBj+9UGhuJfvL01C2bh7tvVYVhTDL3mubiZqLUjmcoYnWa96CGoZ7FtBV8Pd60biQzfTCQlXugt4AzvIcrLxvh6RaFYMttcyMrsoojnIxwXxrRjaPqZxVRkxyUprIc72wtyL3dzJ23BY6xV0t+nF7sGs3vPKtHXgK8bNSKZqe9XUAqEZO0rVfxF6TBtAmtHhqhsswAwRsttF2KtSTLTb54dfD7fnfKUoRKE1XsCB03KxdKKUrleCWBH+qcoVGTGQuSb8eFr89B5sIpdBYMFhq4wbRemvLGskmWuco1I4u6uhQoi5zgllVR0mXoTRAuxt8WVqf8rRFY5TpGMbPnFJri/DixRtKlDgnfPGiO22wBgEGPewO4MLbsYVxe9HjPgE7xvpIRNXTaRQzQuZzTL3J94VU4WrxZ+igUk7mpLA6rGxDUzMiu/wm3XpEEqkoDgkPvWxRBBtKqMQH/JkRKUuoKydmuCvkJTofMGWiFedB9CHRuTZ1YdIuuLrybsZftzLCRlphjFjubCzZNSpnllCi4dSVcnt4Q+Dvv6fUAyxScea60/tEi9InvVCcAIa6QDos7FPgLixtVdKgFhcGz8pgRW+mtQscjBisPzLMsMaO7hjxSXGLTP+yiPox02AwQTnn5KmZcOTTjcqi8enG71YrCLF8UEccWK85jWI/EkA3+/rB2wHfHHPNSWMlQvmhRFkaPRf5bSi/Rv4LbMbiaoYS8kWmIdMUYjjn9RtAqMaAtvHTj6HqGy8yPY5Bq3zpKQHvQTRKkvX4f1j6bpynpUSjhxbNiU0whufEgvPXrA2hKJXnBXEJYGvT3K8Ob5elj5msL0p34maoVfeyxJb7HFngJwdwliRYkudjQcks2pALt5UVchlYr8e+QFIcjn4U5i7VC/V4+KP97R+MVj8JxfqzxacHe6SPt4Wj3F7dhcqOEoWtWNkRzedl3ibWzGTkE5Hc/cI8V2mOX8EXPavhi3TCBp90xewpiwyVN3t2h3zOLBcvNWR/c2nlJMdbp3vgtRD35x7+TneBsEkxd3VLzvn24m0rsSCCBK0Pot26b7dAZWrQVyW1E1uiAK1MyRlDPjmt7FYxeB21h/nmdCSSRFfKffMy+rRer0PoC+ka1TYTFAbNWUVp0vUnT/nYUivrfeHlcLhbTtLyPMuXdniYj1yoB77rG+akYo9sc5FLrsroSwgmT3tIxiwtkVF+IXsTSq3qbJta6iGU9mFK9qMP90Sg9i70Vx5xRMWuTxH7TPxfe8jj89dsEXWIZhbZhw8aq44yHVakI+/pOo7KapJLmxF6P6UDin317enGkEcwbos17qdYjmwgubtxuXXHb8Sv/DwmJdVJVdQh5MBdHrjLA3d54C4P3OWBuzxwlwfu8sBdHrjLA3d54C4P3OWBuzxwlwfu8sBd/hbcZRwlBqmCvBWuz0R8vKPgIxweO1lgX+qgmkUthIUwZNcGXg5f/uPx6fD45fDq9NVo+A+j09PBcDj8N1JW4D1/TRlyYV3Np+4vSIdhpEKwt4TZjrBMhXS5B/YRlojcYQRZp0xwgvZSqp593uFVUVEClT4jh2tn7Vo9QHj05GNJZZ0u5E/PmmxnZCZcWsxmZyY+cklFgVR3nWlq79rXof7QUbaPDK4yHOgIhPR0Ck7PvIwBC1gdXXmu6fSn8WeO09tJL0o+zig3lDZrgvXupQnsip/1yAJPEoMktnLZkYJm8G2Ehhd9bZYXlbpAW+XuSe6dOwF7bNpZviCaw59sHXnWlJ9t06lC2QXVL+NXw2FP3r5ef/Io+eqhLkYzVryT1tBnAkFp66m7uaiCMRqjjR0D80iMhoScpdGTHItntTMeV1qB1lKS/mRgPIM6ZulpYI2DNDDVlUp3qgrWaCeRpglGcFLTCietCTzJMkEgRk5bB18PqWAxIuFD3us48gp5Zqbf0teD2XpXH3yKfA9lMKHEm0NYo0Mrxy+a42yNfCFX9VlER0e9iqCl7r0nVO0dWVgYrWa1fwvn5+/O9YR6639x9OrPf+6353odia7ylFjoCZtjgpaCre8l+OliELA5oN+y8biTfEOq0dI4eC+tdwt6IyHV9F1GryWUaAKh6nsZ/AoC12m14aXohMwt+L2ELy6++xb+6dVXX3/5iIOEZ3//tKN0dfCaP03QemJkQUwfK57yKSIZKAGlBdZC7EjpI/g2zcWzxgHxNtT6bvbNwj1tlx8uzr0RbHUhiGElz609As7Jcgj76vtMTN4KgrPYuj1xZJv00Ts9ZR4e0Ov16SSpzFauWxk1arPWI3bfkdGVQ3ucYV6iGQW7OGZjYSffs8Y4I47RuBiyqhDqmNJdik1thOIqrvH+RrKrjF86MY27Ni+TNAUi23pvq6Npsu76yPdXV+9r5px7A0GQuu/dkeTVcMg1WT/ts7NgRyuMoRDUf8NmzaxYno0aQJwFOw2ZUCkppMSE8Nff1SRbvAj/js3Wxl28+3D15vL2+zc/vH9zMTh/+6ezH85f374/uzj78dInIGTMz88QftSs8Q1zBGJChfeWL3nQZDaBdyD2dYqYC8lj7yYMPzMwdKFam8YIBsCpbGmQXkgii+A7Q1bHcz0jnPD4z6VvtiNJR7xuqd8AGxH565hfE3o6bJAL0Dx+fKoUaLEjGBPG0skKftFo7DkY755j+IJiY8tbvuzK4t9NIhGsrX5m8MK6E22rJANhYVxDpX99Kuhl3Jts0NxzkVc9nT7SL18K752FBQfzMpjjXKgtGkVpdyyOVVVMPGf2jExpC5bwvsyFEnWbnjeYdFRX2o+OvGmf9rrVJRmNXxlpi/FzHMMdlo5LHuIUFsKkkOiiFE4yUb/0SBHuZsUSftC7ftahSH8RYDojEjzfw+bP2rGnxag/4Plw7t8zI4DjS5QtUIwXies0SMFWZeg5hJzmq76c5lIX6A8JteBHd3utRxaIWTikH//X0g8OLqNJLtTdb5RWvNOlHQzouvHUC5eVdMZE5D5s/O9mE199NtnEZ5kkfN4Qu5/xfHbIynp1maajG2Xl/LGqjCvbBw+mrGS6Dscd6re3K5NHoyhzrrSjkxNRykHnvEuiC35fuO5o8CkOj0rtE6YbpdBAUXgBmmkgvimKwx/f1TzqHz9ecT+GkPiieRf5TdPMITbpgW5K48rNUaf6mFGzLU+fYfn8z4F0j4GEwxPN2YbN0Yaewwjbdrn3YYHtswLeLdut/NpR273zViu73chud6SbhvG176uGluimI/pU/65p3z1oGO0uW6Axn9GoqvtUD3aLOr2iNTlGu1HzaKMj5tY9U6VorF/F6WA4GG4SgFH0bcdzd7bwR6GEP4HR/rkJH/JTTKgNw2ht6FwVWn+8qkRjW79QsXWgzcd6PoLV/YkI7gh7Zn2hOr9uQVootXWF4Bwq/BrCB+5zdE/Bbi9g1WzP//df2QiuTgZ2UuZCMvXIWFyzoNdRsm0NDZJHcTTy4JRp6+jm1WoiLH4w+XpNX/t6kBwtlTZ0b8KPUzy4Jb/uj070rvAOl51fzggVY8QxZi6M9JDzLLG/COd90i/hV/9tkN5F1EyHWrZXUC+OSmHy9gxFSnB2vQoXvvUSH1/5pL9+cKd/QC0Y/4Tvej9676dWFvD+w1XUdNoDLBuxoEgnFl5GXXpjot/8oO9WUS7UrOLsLPJD8jGJblTfiuLtA6hdLaxW/o4rfYeKAdWvxNHniNs2/wP1tSCT sidebar_class_name: put api-method info_path: docs/api/communications custom_edit_url: null canonical: 'https://docs.nullplatform.com/docs/api/inbox-rule-update' --- Replaces the definition of one of your organization's inbox rules. Send the whole definition: fields you leave out are removed. The `id` in the body must match the one in the path. Editing a rule never changes notifications that were already sent. ℹ️ **Note:** It can't start with `platform.`. Using a built-in rule's ID edits that rule for your organization.\n","example":"acme.security_finding"},"status":{"type":"string","enum":["active","deprecated"],"description":"Whether the rule is active. Defaults to `active`. `deprecated` means deactivated.","example":"active"},"source":{"description":"What makes the rule fire:\n\n- `{ \"kind\": \"invoked\" }`: your code calls the emission endpoint.\n- A source name, like `\"deployment\"`: the entity changes status in nullplatform. See `GET /communications/inbox_rule/source`.\n- `{ \"kind\": \"stale\", ... }`: an entity stays in a status for too long.\n","oneOf":[{"type":"string"},{"type":"object","additionalProperties":true}],"example":{"kind":"invoked"}},"context_schema":{"type":"object","additionalProperties":true,"description":"A JSON Schema for the data each send carries. An invoked rule must require `id`, because sends are idempotent by it.","example":{"type":"object","required":["id","service","owner_id"],"properties":{"id":{"type":"string"},"service":{"type":"string"},"summary":{"type":"string"},"owner_id":{"type":"integer"}}}},"category":{"type":"object","description":"How the rule shows up in inbox settings. All six fields are required.","required":["group","label","description","configurable","allows_all","default_mode"],"properties":{"group":{"type":"string","description":"The group the rule is listed under in inbox settings.","example":"security"},"label":{"type":"string","description":"The rule's name in inbox settings.","example":"Security findings"},"description":{"type":"string","maxLength":70,"description":"One line on what the rule announces.","example":"Vulnerabilities your CI scanners report."},"configurable":{"type":"boolean","description":"Whether people can change their mode for this rule.","example":true},"allows_all":{"type":"boolean","description":"Whether people can choose **Everything** for this rule under a resource. Requires `configurable`.","example":true},"default_mode":{"type":"string","enum":["off","involved","all"],"description":"What people get until they change it.","example":"involved"}}},"severity":{"type":"string","enum":["informational","maintenance","degraded","outage"],"description":"Sets the icon and the color of the notification.","example":"degraded"},"audience":{"type":"array","description":"One entry per reading. Each entry is a separate notification with its own wording.","items":{"type":"object","required":["as","action","content"],"additionalProperties":true,"properties":{"as":{"type":"string","description":"The name of this reading.","example":"owner"},"who":{"type":"object","additionalProperties":true,"description":"Who receives this reading: `{ \"user\": \"${{ context.owner_id }}\" }` for a user from the context, or `{ \"can\": \"approval_request:approve\" }` for everyone who holds that action on the resource. Without `who`, only the people who chose **Everything** receive it.","example":{"user":"${{ context.owner_id }}"}},"action":{"type":"string","description":"The rule's ID, or an ID that starts with it.","example":"acme.security_finding"},"content":{"type":"object","required":["title"],"properties":{"title":{"type":"string","description":"The notification's title. Accepts templates like `${{ context.service }}` and inline Markdown.","example":"Security finding on ${{ context.service }}"},"body":{"type":"string","description":"The notification's body. Accepts templates, inline Markdown, links, and lists.","example":"${{ context.summary }}"}}},"fallback":{"type":"object","additionalProperties":true,"description":"Another reading, with the same fields, for when `who` resolves nobody."}}}},"visible_to":{"type":"array","maxItems":1,"items":{"type":"string"},"description":"The one NRN the rule applies under. Defaults to your organization. Sends for resources outside it are refused.","example":["organization=1:account=2"]}}}}}}} > ℹ️ **Note:** It can't start with `platform.`. Using a built-in rule's ID edits that rule for your organization.\n","example":"acme.security_finding"},"status":{"type":"string","enum":["active","deprecated"],"description":"Whether the rule is active. Defaults to `active`. `deprecated` means deactivated.","example":"active"},"source":{"description":"What makes the rule fire:\n\n- `{ \"kind\": \"invoked\" }`: your code calls the emission endpoint.\n- A source name, like `\"deployment\"`: the entity changes status in nullplatform. See `GET /communications/inbox_rule/source`.\n- `{ \"kind\": \"stale\", ... }`: an entity stays in a status for too long.\n","oneOf":[{"type":"string"},{"type":"object","additionalProperties":true}],"example":{"kind":"invoked"}},"context_schema":{"type":"object","additionalProperties":true,"description":"A JSON Schema for the data each send carries. An invoked rule must require `id`, because sends are idempotent by it.","example":{"type":"object","required":["id","service","owner_id"],"properties":{"id":{"type":"string"},"service":{"type":"string"},"summary":{"type":"string"},"owner_id":{"type":"integer"}}}},"category":{"type":"object","description":"How the rule shows up in inbox settings. All six fields are required.","required":["group","label","description","configurable","allows_all","default_mode"],"properties":{"group":{"type":"string","description":"The group the rule is listed under in inbox settings.","example":"security"},"label":{"type":"string","description":"The rule's name in inbox settings.","example":"Security findings"},"description":{"type":"string","maxLength":70,"description":"One line on what the rule announces.","example":"Vulnerabilities your CI scanners report."},"configurable":{"type":"boolean","description":"Whether people can change their mode for this rule.","example":true},"allows_all":{"type":"boolean","description":"Whether people can choose **Everything** for this rule under a resource. Requires `configurable`.","example":true},"default_mode":{"type":"string","enum":["off","involved","all"],"description":"What people get until they change it.","example":"involved"}}},"severity":{"type":"string","enum":["informational","maintenance","degraded","outage"],"description":"Sets the icon and the color of the notification.","example":"degraded"},"audience":{"type":"array","description":"One entry per reading. Each entry is a separate notification with its own wording.","items":{"type":"object","required":["as","action","content"],"additionalProperties":true,"properties":{"as":{"type":"string","description":"The name of this reading.","example":"owner"},"who":{"type":"object","additionalProperties":true,"description":"Who receives this reading: `{ \"user\": \"${{ context.owner_id }}\" }` for a user from the context, or `{ \"can\": \"approval_request:approve\" }` for everyone who holds that action on the resource. Without `who`, only the people who chose **Everything** receive it.","example":{"user":"${{ context.owner_id }}"}},"action":{"type":"string","description":"The rule's ID, or an ID that starts with it.","example":"acme.security_finding"},"content":{"type":"object","required":["title"],"properties":{"title":{"type":"string","description":"The notification's title. Accepts templates like `${{ context.service }}` and inline Markdown.","example":"Security finding on ${{ context.service }}"},"body":{"type":"string","description":"The notification's body. Accepts templates, inline Markdown, links, and lists.","example":"${{ context.summary }}"}}},"fallback":{"type":"object","additionalProperties":true,"description":"Another reading, with the same fields, for when `who` resolves nobody."}}}},"visible_to":{"type":"array","maxItems":1,"items":{"type":"string"},"description":"The one NRN the rule applies under. Defaults to your organization. Sends for resources outside it are refused.","example":["organization=1:account=2"]}}},"created_at":{"type":"string","format":"date-time","description":"When the rule was created.","example":"2026-10-20T14:03:11.000Z"},"updated_at":{"type":"string","format":"date-time","description":"When the rule was last updated.","example":"2026-10-20T14:03:11.000Z"},"organization_state":{"type":"object","description":"Only on built-in rules, in the list: 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}}}}},{"title":"DryRunResult","type":"object","properties":{"valid":{"type":"boolean","description":"Always `true`: an invalid definition answers `400`.","example":true}}}]}}}},"400":{"description":"The definition, the context, or the NRN is invalid. Each entry in `errors` points to one problem.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"A summary of every problem found.","example":"invalid notification type: /category/description must be at most 70 characters"},"errors":{"type":"array","description":"One entry per problem.","items":{"type":"object","properties":{"path":{"type":"string","description":"A JSON pointer to the invalid field in the request body.","example":"/category/description"},"message":{"type":"string","description":"What's wrong with that field.","example":"must be at most 70 characters"}}}}}}}}},"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."}}}}}}}} >