Skip to main content
DELETE
/
v1
/
monitor
/
{entity_id}
JavaScript
import Openregister from 'openregister';

const client = new Openregister({
  apiKey: process.env['OPENREGISTER_API_KEY'], // This is the default and can be omitted
});

await client.monitor.delete('entity_id');

Delete a monitor

Permanently removes a monitor and stops all future webhook notifications for that entity. Cost: 0 credits
Early Access. Only available to select API users and enterprise customers. Request access to get started.
See the Monitoring guide for a full overview of how monitoring works, including how to manage the monitor lifecycle.

Entity ID

Pass the same entity_id that was used when creating the monitor — the company register ID (e.g. DE-HRB-F1103-267645) or the person UUID. Deletion is immediate and permanent. To resume monitoring the same entity you must create a new monitor.
Deletion cannot be undone. All preferences configured on the monitor are removed and no further notifications will be delivered for that entity.

Use Cases

Offboarding a client or counterparty — When a business relationship ends, delete the corresponding monitor to stop receiving notifications for that entity and avoid unnecessary noise. Pruning stale monitors — Periodically review your monitor list and remove entities that are no longer relevant to your business to keep your subscription list clean.

Authorizations

Authorization
string
header
required

API Key Authentication Provide your API key as a Bearer token in the Authorization header.

Path Parameters

entity_id
string
required

Response

Deleted