PUT
/
customers
/
{customer_id}
/
watchlists
/
alerts
/
{alert_id}
Update watchlist alert
curl --request PUT \
  --url https://api-sandbox.synctera.com/v0/customers/{customer_id}/watchlists/alerts/{alert_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "created": "2023-11-07T05:31:56Z",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "provider_info": {},
  "provider_subject_id": "<string>",
  "provider_subscription_id": "<string>",
  "provider_watchlist_name": "<string>",
  "status": "ACTIVE",
  "urls": [
    "<string>"
  ],
  "vendor_info": {
    "content_type": "application/json",
    "json": {},
    "vendor": "SOCURE"
  }
}'
This response does not have an example.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
alert_id
string<uuid>
required

Unique identifier for this watchlist alert.

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

​
customer_id
string<uuid>
required

The customer's unique identifier

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

Body

application/json

A watchlist body

​
status
enum<string>
required

The status of this alert

Available options:
ACTIVE,
SUPPRESSED
​
created
string<date-time>

When this alert was created

​
id
string<uuid>

Unique identifier for this alert

​
provider_info
object

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_id
string

The id of the provider subject for this alert

​
provider_subscription_id
string

The id of the provider subscription for this alert

​
provider_watchlist_name
string

The name of the provider for this alert

​
urls
string[]

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

​
vendor_info
object

The information provided to Synctera from the vendor. Interpretation of this object is up to the client.

Response

Watchlist alert was updated