Sign in

v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB
Watchlist (deprecated)

Update watchlist alert

put/customers/{customer_id}/watchlists/alerts/{alert_id}

Path parameters

alert_idstring uuid required
Example:7d943c51-e4ff-4e57-9558-08cab6b963c7

Unique identifier for this watchlist alert.

customer_idstring uuid required
Example:7d943c51-e4ff-4e57-9558-08cab6b963c7

The customer's unique identifier

Request body

createdstring date-time

When this alert was created

idstring uuid

Unique identifier for this alert

provider_infoobject

The information provided to Synctera that triggered this alert, as an arbitrary JSON object. Interpretation of this object is up to the client.

provider_subject_idstring

The id of the provider subject for this alert

provider_subscription_idstring

The id of the provider subscription for this alert

provider_watchlist_namestring

The name of the provider for this alert

status'ACTIVE' | 'SUPPRESSED' required

The status of this alert

urlsstring[]

Where to get more information about this alert (according to our third-party data provider).

Example request

{
  "vendor_info": {
    "vendor": "SOCURE"
  }
}

Response

Watchlist alert was updated