Sign in
Notifications

Update notification

Update an existing notification owned by the current account. All type-specific rules from creation apply.

patch/notifications/{notification_id}

Path parameters

notification_idinteger required

ID of the notification.

ID of the notification.

Request body

method_idinteger nullable

Notification method ID to use.

type'email' | 'domain' | 'advanced' | 'raw' | 'dark_web' required
valuestring nullable

Value to monitor (required for EMAIL/DOMAIN types).

filtersobject nullable

Filters when type=ADVANCED or RAW. Parsed according to type.

auto_unlockboolean nullable

If true, automatically unlock new matching leaks (consumes points).

max_pointsinteger nullable

Daily points cap for auto-unlock (if enabled).

second_type'ALL' | 'EMPLOYEES' | 'THIRD_PARTIES' | 'CUSTOMERS'
bulkboolean nullable

Create multiple notifications at once (e.g., newline-separated values).

Example request

{
  "method_id": 1,
  "type": "domain",
  "value": "example.com"
}

Response

Notification updated successfully.

idinteger required

Notification ID.

method_idinteger required

ID of the notification method used for delivery.

type'email' | 'domain' | 'advanced' | 'raw' | 'dark_web' required
second_type'ALL' | 'EMPLOYEES' | 'THIRD_PARTIES' | 'CUSTOMERS'
valuestring nullable

Monitored value (email address, domain, search query, etc.).

filtersobject nullable

Additional search filters applied to this notification.

last_searched_atstring date-time nullable

Last time this notification was checked for new results.

is_activeboolean required

Whether this notification is currently active.

timestampstring date-time required

Creation date of this notification.

method_type'email' | 'slack' | 'telegram' | 'webhook' | 'discord'
method_valuestring nullable

Destination of the associated method.

method_extra_emailsstring[] nullable

Additional BCC recipients of the associated method (email methods only).

auto_unlockboolean nullable

Whether new results are automatically unlocked.

max_pointsinteger nullable

Maximum points to spend per notification run for auto-unlock.

daily_spentinteger nullable

Points spent today by auto-unlock on this notification.

daily_reset_atstring date-time nullable

Next daily reset time for the spent counter.

total_notificationsinteger nullable

Total number of notification runs executed.

total_costinteger nullable

Total points consumed by this notification across all runs.

Changes

No recorded changes to this endpoint across all 1 revision of this API.