---
title: "Update a notifier"
method: PATCH
path: "/v2/notifiers/{notifier_id}"
tags: ["Notifiers"]
---

# Update a notifier

`PATCH /v2/notifiers/{notifier_id}`

Partially updates an existing notifier. When changing `type`, provide the destination fields required by the new notifier type.

## Path parameters

- `notifier_id` string, required

## Request body

- UpdateNotifierRequest — Partial notifier update. All request body fields are optional individually, but at least one field must be provided. When changing `type`, include the destination field required by the new type. Secret header values returned by GET or LIST are masked as an empty string; omit those entries or replace them with the real value when updating.
  - `project_id` string — Optional. New containing project. Workspace-scoped callers may set an empty value to make the notifier workspace-wide. Project-scoped API keys remain pinned to the API key's project.
  - `display_name` string — Optional. New human-readable notifier name.
  - `metadata` object — Optional. Replacement custom JSON metadata.
  - `type` 'NOTIFIER_TYPE_UNSPECIFIED' | 'NOTIFIER_TYPE_EMAIL' | 'NOTIFIER_TYPE_SLACK_WEBHOOK' | 'NOTIFIER_TYPE_WEBHOOK'
  - `emails` string[] — Optional replacement email recipients. Required when changing `type` to `NOTIFIER_TYPE_EMAIL`.
  - `incoming_webhook_url` string — Optional replacement Slack incoming webhook URL. Required when changing `type` to `NOTIFIER_TYPE_SLACK_WEBHOOK`.
  - `webhook_url` string — Optional replacement generic webhook URL. Required when changing `type` to `NOTIFIER_TYPE_WEBHOOK`.
  - `headers` object — Optional replacement generic webhook headers. Secret header values returned by GET or LIST are masked as an empty string; omit those entries or replace them with the real value when updating.

## Response `200`

OK

- UpdateNotifierResponse
  - `notifier` union, required — Notifier resource. The destination field present on the resource depends on `type` and is captured in `oneOf`.
    - object — `emails` is present for email notifiers.
      - `_id` string, required — Unique notifier identifier assigned by ORQ.
      - `project_id` string — Project that contains the notifier. Empty for workspace-wide notifiers.
      - `display_name` string, required — Human-readable notifier name.
      - `created_at` string, date-time, required — Time when the notifier was created.
      - `updated_at` string, date-time, required — Time when the notifier was last updated.
      - `created_by_id` string — User ID that created the notifier.
      - `updated_by_id` string — User ID that last updated the notifier.
      - `metadata` object — Custom JSON metadata stored with the notifier.
      - `type` 'NOTIFIER_TYPE_EMAIL', required
      - `emails` string[], required — Email addresses notified when `type` is `NOTIFIER_TYPE_EMAIL`.
      - `incoming_webhook_url` string — Slack incoming webhook URL used when `type` is `NOTIFIER_TYPE_SLACK_WEBHOOK`.
      - `webhook_url` string — Generic webhook URL used when `type` is `NOTIFIER_TYPE_WEBHOOK`.
      - `headers` object — Optional HTTP headers for generic webhooks. Each entry may be a string value or an object with `secret` and `value`.
    - object — `incoming_webhook_url` is present for Slack webhook notifiers.
      - `_id` string, required — Unique notifier identifier assigned by ORQ.
      - `project_id` string — Project that contains the notifier. Empty for workspace-wide notifiers.
      - `display_name` string, required — Human-readable notifier name.
      - `created_at` string, date-time, required — Time when the notifier was created.
      - `updated_at` string, date-time, required — Time when the notifier was last updated.
      - `created_by_id` string — User ID that created the notifier.
      - `updated_by_id` string — User ID that last updated the notifier.
      - `metadata` object — Custom JSON metadata stored with the notifier.
      - `type` 'NOTIFIER_TYPE_SLACK_WEBHOOK', required
      - `emails` string[] — Email addresses notified when `type` is `NOTIFIER_TYPE_EMAIL`.
      - `incoming_webhook_url` string, required — Slack incoming webhook URL used when `type` is `NOTIFIER_TYPE_SLACK_WEBHOOK`.
      - `webhook_url` string — Generic webhook URL used when `type` is `NOTIFIER_TYPE_WEBHOOK`.
      - `headers` object — Optional HTTP headers for generic webhooks. Each entry may be a string value or an object with `secret` and `value`.
    - object — `webhook_url` is present for generic webhook notifiers; `headers` is optional.
      - `_id` string, required — Unique notifier identifier assigned by ORQ.
      - `project_id` string — Project that contains the notifier. Empty for workspace-wide notifiers.
      - `display_name` string, required — Human-readable notifier name.
      - `created_at` string, date-time, required — Time when the notifier was created.
      - `updated_at` string, date-time, required — Time when the notifier was last updated.
      - `created_by_id` string — User ID that created the notifier.
      - `updated_by_id` string — User ID that last updated the notifier.
      - `metadata` object — Custom JSON metadata stored with the notifier.
      - `type` 'NOTIFIER_TYPE_WEBHOOK', required
      - `emails` string[] — Email addresses notified when `type` is `NOTIFIER_TYPE_EMAIL`.
      - `incoming_webhook_url` string — Slack incoming webhook URL used when `type` is `NOTIFIER_TYPE_SLACK_WEBHOOK`.
      - `webhook_url` string, required — Generic webhook URL used when `type` is `NOTIFIER_TYPE_WEBHOOK`.
      - `headers` object — Optional HTTP headers for generic webhooks. Each entry may be a string value or an object with `secret` and `value`.

---

[API](https://skmtc.net/orq-ai/apis/orq-ai-api.md) · [All operations](https://skmtc.net/orq-ai/apis/orq-ai-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/orq-ai/orq-ai-api/versions/6a22c53a2580/schema)