Skip to main content
PATCH
/
kyc
/
watchlists
/
{watchlist_id}
Update Watchlist
curl --request PATCH \
  --url https://api.example.com/kyc/watchlists/{watchlist_id}

Endpoint

PATCH /kyc/watchlists/{watchlist_id}

Authentication

Requires watchlist:update permission.

Path Parameters

watchlist_id
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"]
  }'

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"],
    "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

CodeDescription
200Success
400Bad Request - Invalid parameters
401Unauthorized
403Forbidden - Missing watchlist:update permission
404Not Found
500Internal Server Error