Remove Breach Alert Subscriptions for Users

Remove user breach alert subscriptions

Allows you to delete Exposure alert subscriptions for one or more email addresses.

DELETEhttps://api.enzoic.com/v1/breach-monitoring-for-users

Authorization

enzoic_auth

Body

application/json

usernameHashesarray of string

An array of SHA256 hashes of the lowercased email addresses you wish to remove breach monitoring for. Maximum number of entries in a single post is 15,000.

customDatastring

Can be used in lieu of the array of usernames if you wish to delete all monitored usernames with this customData value. This parameter is ignored if you also include the usernameHashes parameter - use one or the other, but not both.

Response

200

The call was successful. You will no longer receive alerts for the provided email addresses.

Body

application/json

deletedinteger

The number of alert subscriptions deleted.

Example: 1

notFoundinteger

The number of provided email hashes which were not found in the alert subscriptions table.

Example: 0

Request

JavaScriptCurlPython

const response = await fetch('https://api.enzoic.com/v1/breach-monitoring-for-users', {
    method: 'DELETE',
    headers: {
      "Authorization": "basic <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "deleted": 1,
  "notFound": 0
}