Subscribe a watchlist to event types
curl --request POST \
--url https://lens-api.tic.io/watchlists/{id}/subscriptions \
--header 'Content-Type: application/json-patch+json' \
--header 'x-api-key: <api-key>' \
--data '
{
"subscribeToAll": true
}
'import requests
url = "https://lens-api.tic.io/watchlists/{id}/subscriptions"
payload = { "subscribeToAll": True }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json-patch+json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json-patch+json'},
body: JSON.stringify({subscribeToAll: true})
};
fetch('https://lens-api.tic.io/watchlists/{id}/subscriptions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://lens-api.tic.io/watchlists/{id}/subscriptions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'subscribeToAll' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json-patch+json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://lens-api.tic.io/watchlists/{id}/subscriptions"
payload := strings.NewReader("{\n \"subscribeToAll\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json-patch+json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://lens-api.tic.io/watchlists/{id}/subscriptions")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json-patch+json")
.body("{\n \"subscribeToAll\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://lens-api.tic.io/watchlists/{id}/subscriptions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n \"subscribeToAll\": true\n}"
response = http.request(request)
puts response.read_body[
{
"subscriptionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"eventType": "companyAddress",
"eventTypeName": "<string>",
"lastUpdatedAtUtc": "2023-11-07T05:31:56Z"
}
]Watchlist
Subscribe a watchlist to event types
Subscribes the watchlist to a single EventType or, when SubscribeToAll is true, to every non-deprecated event type. Existing subscriptions are not duplicated.
POST
/
watchlists
/
{id}
/
subscriptions
Subscribe a watchlist to event types
curl --request POST \
--url https://lens-api.tic.io/watchlists/{id}/subscriptions \
--header 'Content-Type: application/json-patch+json' \
--header 'x-api-key: <api-key>' \
--data '
{
"subscribeToAll": true
}
'import requests
url = "https://lens-api.tic.io/watchlists/{id}/subscriptions"
payload = { "subscribeToAll": True }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json-patch+json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json-patch+json'},
body: JSON.stringify({subscribeToAll: true})
};
fetch('https://lens-api.tic.io/watchlists/{id}/subscriptions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://lens-api.tic.io/watchlists/{id}/subscriptions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'subscribeToAll' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json-patch+json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://lens-api.tic.io/watchlists/{id}/subscriptions"
payload := strings.NewReader("{\n \"subscribeToAll\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json-patch+json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://lens-api.tic.io/watchlists/{id}/subscriptions")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json-patch+json")
.body("{\n \"subscribeToAll\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://lens-api.tic.io/watchlists/{id}/subscriptions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n \"subscribeToAll\": true\n}"
response = http.request(request)
puts response.read_body[
{
"subscriptionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"eventType": "companyAddress",
"eventTypeName": "<string>",
"lastUpdatedAtUtc": "2023-11-07T05:31:56Z"
}
]Pro+ tier
Authorizations
Path Parameters
Watchlist GUID
Body
application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Available options:
companyAddress, companyName, companyStatus, companyRegistration, companyIntelligence, companyBeneficialOwner, companyDocument, companyWorkplace, companyPerson, companyRegisteredOffice, companyShareCapital, companyPurpose, companyDebtBalance, companyOrderToPayCase, companyFinancialDocument, companyCase, companyWorkplaceAddress, unused_Company4, unused_Company5, unused_Company6, unused_Company7, unused_Company8, unused_Company9, unused_Company10, personAddress, personName, personIntelligence, personStatus, personCompany, unused_Person1, unused_Person2, unused_Person3, unused_Person4, unused_Person5, unused_Person6, unused_Person7, unused_Person8, unused_Person9, unused_Person10, propertyOwnershipChange, propertyMortageDeedChange, unused_Property1, unused_Property2, unused_Property3, unused_Property4, unused_Property5, vehicleOwnerChange, vehicleUserChange, vehicleStatusChange, vehicleInspection, vehicleStolen, unused_Vehicle1, unused_Vehicle2, unused_Vehicle3, unused_Vehicle4, unused_Vehicle5 Response
Newly created subscriptions (may be empty if all already existed)
Available options:
companyAddress, companyName, companyStatus, companyRegistration, companyIntelligence, companyBeneficialOwner, companyDocument, companyWorkplace, companyPerson, companyRegisteredOffice, companyShareCapital, companyPurpose, companyDebtBalance, companyOrderToPayCase, companyFinancialDocument, companyCase, companyWorkplaceAddress, unused_Company4, unused_Company5, unused_Company6, unused_Company7, unused_Company8, unused_Company9, unused_Company10, personAddress, personName, personIntelligence, personStatus, personCompany, unused_Person1, unused_Person2, unused_Person3, unused_Person4, unused_Person5, unused_Person6, unused_Person7, unused_Person8, unused_Person9, unused_Person10, propertyOwnershipChange, propertyMortageDeedChange, unused_Property1, unused_Property2, unused_Property3, unused_Property4, unused_Property5, vehicleOwnerChange, vehicleUserChange, vehicleStatusChange, vehicleInspection, vehicleStolen, unused_Vehicle1, unused_Vehicle2, unused_Vehicle3, unused_Vehicle4, unused_Vehicle5