Add multiple persons to a watchlist

Max+ tier

POSThttps://lens-api.tic.io/watchlists/{id}/persons/batch

Authorization

x-api-keystringheaderrequired

Your API key, sent in the x-api-key header.

Path parameters

idstringrequired

Watchlist GUID

format: uuid

Bodyapplication/json

personIdsinteger[] | null

Responses

What was done with each ID · application/json

addedAddedWatchListMember_Dto[] | null

Hide child attributes

watchListMemberGuidstring

format: uuid

companyIdinteger | null

format: int32

personIdinteger | null

format: int32

alreadyMembersinteger[] | null

notFoundinteger[] | null

Authorization

Stored in this browser only (until you forget it) and sent as the x-api-key header through the documentation proxy.

Path

id *string

Body application/json

Enter your API key to send.

Request

curl -X POST "https://lens-api.tic.io/watchlists/{id}/persons/batch" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "personIds": [
    123
  ]
}'

{
  "added": [
    {
      "watchListMemberGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "companyId": 123,
      "personId": 123
    }
  ],
  "alreadyMembers": [
    123
  ],
  "notFound": [
    123
  ]
}