Update Watchlist
curl --request PATCH \
--url https://api.example.com/kyc/watchlists/{watchlist_id}import requests
url = "https://api.example.com/kyc/watchlists/{watchlist_id}"
response = requests.patch(url)
print(response.text)const options = {method: 'PATCH'};
fetch('https://api.example.com/kyc/watchlists/{watchlist_id}', 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://api.example.com/kyc/watchlists/{watchlist_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/kyc/watchlists/{watchlist_id}"
req, _ := http.NewRequest("PATCH", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.example.com/kyc/watchlists/{watchlist_id}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/kyc/watchlists/{watchlist_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
response = http.request(request)
puts response.read_bodyWatchlists
Update Watchlist
Modify watchlist configuration
PATCH
/
kyc
/
watchlists
/
{watchlist_id}
Update Watchlist
curl --request PATCH \
--url https://api.example.com/kyc/watchlists/{watchlist_id}import requests
url = "https://api.example.com/kyc/watchlists/{watchlist_id}"
response = requests.patch(url)
print(response.text)const options = {method: 'PATCH'};
fetch('https://api.example.com/kyc/watchlists/{watchlist_id}', 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://api.example.com/kyc/watchlists/{watchlist_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/kyc/watchlists/{watchlist_id}"
req, _ := http.NewRequest("PATCH", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.example.com/kyc/watchlists/{watchlist_id}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/kyc/watchlists/{watchlist_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
response = http.request(request)
puts response.read_bodyEndpoint
PATCH /kyc/watchlists/{watchlist_id}
Authentication
Requireswatchlist:update permission.
Path Parameters
string
required
The unique identifier of the watchlist
Request Body
All parameters are optional. Only include fields you want to update.Request Example
curl -X PATCH https://stg.kyc.legaltalent.ai/kyc/watchlists/550e8400-e29b-41d4-a716-446655440000 \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"check_frequency": "weekly"
}'
Additional Request Examples
Pause Watchlist
curl -X PATCH https://stg.kyc.legaltalent.ai/kyc/watchlists/550e8400-e29b-41d4-a716-446655440000 \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"status": "paused"
}'
Update Multiple Settings
curl -X PATCH https://stg.kyc.legaltalent.ai/kyc/watchlists/550e8400-e29b-41d4-a716-446655440000 \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "Updated Watchlist Name",
"check_frequency": "weekly",
"status": "active",
"lists_to_monitor": ["ofac", "un", "eu"],
"tags": ["updated", "priority"]
}'
Update Tags
curl -X PATCH https://stg.kyc.legaltalent.ai/kyc/watchlists/550e8400-e29b-41d4-a716-446655440000 \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"tags": ["reviewed", "compliance", "q1-2025"]
}'
Response
{
"status": "success",
"data": {
"watchlist_id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Updated Watchlist Name",
"check_frequency": "weekly",
"status": "active",
"lists_to_monitor": ["ofac", "un", "eu"],
"tags": ["updated", "priority"],
"updated_at": "2024-11-22T11:00:00Z"
}
}
Error Responses
404 Not Found
{
"status": "error",
"error": {
"type": "NotFoundError",
"message": "Watchlist not found",
"code": "WATCHLIST_NOT_FOUND"
}
}
Status Codes
| Code | Description |
|---|---|
| 200 | Success |
| 400 | Bad Request - Invalid parameters |
| 401 | Unauthorized |
| 403 | Forbidden - Missing watchlist:update permission |
| 404 | Not Found |
| 500 | Internal Server Error |
⌘I