Notifications

Update notification method

Changed on

Update an existing notification method owned by the current account.

The body replaces the method, except name: omit it to keep the current name, send null or an empty string to clear it.

Errors

  • 401 Authentication required.
  • 404 Notification method not found.
  • 422 Request validation error.
patch/notification_methods/{method_id}

Request

Path parameters

method_idinteger required

ID of the notification method.

Request body

type'email' | 'slack' | 'telegram' | 'webhook' | 'discord' required
namestring nullable

Optional label telling this channel apart from others of the same type (e.g. the Slack channel the webhook posts to). On update, omit it to keep the current name; send null or an empty string to clear it.

valuestring required

Primary value (e.g., webhook URL, bot token, or email address).

second_valuestring nullable

Secondary value when required by the method (e.g., Telegram chat_id).

extra_emailsstring[] nullable

Up to 4 additional email recipients (delivered as BCC). Only allowed when type=email. Total recipients (value + extra_emails) must be ≤ 5.

Example request

{
  "type": "email",
  "value": "alerts@example.com"
}

Response

Method updated successfully.

idinteger required

Notification method ID.

type'email' | 'slack' | 'telegram' | 'webhook' | 'discord' required
namestring nullable

User-given label of this channel, null when unnamed.

valuestring required

Primary destination (email address, webhook URL, channel ID, etc.).

second_valuestring nullable

Secondary value (e.g. Telegram chat ID).

extra_emailsstring[] nullable

Additional email recipients delivered as BCC (email methods only, max 4).

timestampstring date-time required

Creation date of this notification method.

status'active' | 'suspended' | 'paused'

Delivery state. active: alerts are delivered. suspended: deliveries kept failing, so LeakRadar stopped sending; it retries every few hours and resumes on the first delivery that goes through. paused: paused by you. Alerts using a suspended or paused method keep running; their results stay in the monitoring history.

suspended_atstring date-time nullable

When the method was suspended or paused.

consecutive_failuresinteger

Failed deliveries in a row that prove the destination is broken (gone, refused or down), since the last successful one.

failing_sincestring date-time nullable

First failure of the current streak.

last_failure_atstring date-time nullable

Last failed delivery.

last_success_atstring date-time nullable

Last successful delivery, test sends included.

last_errorstring nullable

Why the last delivery failed.

Changes

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status