Skip to main content
PUT
/
customers
/
{customer_id}
/
watchlists
/
subscriptions
/
{subscription_id}
Update watchlist monitoring subscription
curl --request PUT \
  --url https://api-sandbox.synctera.com/v0/customers/{customer_id}/watchlists/subscriptions/{subscription_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "auto_renew": true,
  "created": "2023-11-07T05:31:56Z",
  "customer_consent": true,
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "period_end": "2023-12-25",
  "period_start": "2023-12-25",
  "provider_subscription_id": "<string>",
  "status": "ACTIVE"
}'
{
  "auto_renew": true,
  "created": "2023-11-07T05:31:56Z",
  "customer_consent": true,
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "period_end": "2023-12-25",
  "period_start": "2023-12-25",
  "provider_subscription_id": "<string>",
  "status": "ACTIVE"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
subscription_id
string<uuid>
required

Watchlist monitoring subscription ID

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

Watchlist monitoring subscription to be updated. The only field that matters is status; all other fields are ignored.

​
customer_consent
boolean
required

Whether this customer has consented to being enrolled for watchlist monitoring

​
auto_renew
boolean

Whether this subscription should automatically renew when the subscription period is over (default: vendor-dependent).

​
created
string<date-time>

When this subscription was created

​
id
string<uuid>

Unique identifier for this subscription

​
period_end
string<date>

The date when monitoring of this individual should end.

​
period_start
string<date>

The date when monitoring of this individual should begin (default: today).

​
provider_subscription_id
string

External provider subscription id

​
status
enum<string>
Available options:
ACTIVE,
INACTIVE

Response

Updated watchlist subscription

​
customer_consent
boolean
required

Whether this customer has consented to being enrolled for watchlist monitoring

​
auto_renew
boolean

Whether this subscription should automatically renew when the subscription period is over (default: vendor-dependent).

​
created
string<date-time>

When this subscription was created

​
id
string<uuid>

Unique identifier for this subscription

​
period_end
string<date>

The date when monitoring of this individual should end.

​
period_start
string<date>

The date when monitoring of this individual should begin (default: today).

​
provider_subscription_id
string

External provider subscription id

​
status
enum<string>
Available options:
ACTIVE,
INACTIVE