Skip to main content
POST
Put people on the watchlist

Authorizations

X-API-Key
string
header
required

Domain-scoped API key. Generate and manage keys from the API Keys page in Settings.

Accepted in two forms:

  • X-API-Key: <key> header (preferred)
  • Authorization: Bearer <key> header (also accepted)

Body

application/json
upns
string
required

UPNs or emails separated by commas, semicolons, spaces or new lines, up to 50,000. Matched whole and without regard to case, against each user's UPN and email addresses.

reason
string
required

Why these people are watched. Every entry gets the same reason.

Minimum string length: 1
expires_at
string<date-time>

When the entries come off the watchlist; must be in the future. Defaults to 90 days.

Response

Who was added and who was not

added
object[]
already_on_watchlist
object[]

People already watched. Their entries are left as they are.

not_tracked
object[]

Added, but inactive or not tracked, so TOTAL's daily review never ranks them and being watched gives them no priority.

not_found
string[]

UPNs or emails that matched nobody.

ignored
string[]

Words that are not UPNs or emails (no @).