Remove a watchlist entry
/watchlist/{watch_id}Removes an entry from your watchlist. Check-ins stop matching it straight away, and the entry's personal data (name, phone number, ID number hash, reason) is erased. Past matches stay in the audit trail, without them.
Scope: watchlist:write · Plan: Pro and Enterprise in live mode; every plan in test mode.
Send Authorization: Bearer <token> on every request. The token is one of:
| Prefix | What it is | Where it may be used |
|---|---|---|
agoo_sk_live_ | Secret key, live mode | Your servers only |
agoo_sk_test_ | Secret key, test mode | Your servers only |
agoo_pk_live_ | Publishable key, live mode | Browsers and apps: create pre-registrations and bookings, read public booking types (with their intake questions) and their free slots, read the visit types open for pre-registration with their public forms. Never lists people. |
agoo_pk_test_ | Publishable key, test mode | As above, in test mode |
Admins create keys in Console → Developers → API keys and choose each key's scopes. A key is shown once. Never put a secret key in a URL, a browser or a mobile app.
In: header
Scope: watchlist:write
Path Parameters
The watchlist entry's ID.
^watch_[0-7][0-9a-hjkmnp-tv-z]{25}$"watch_01m0fqhdr0e31ray1qxa2x5vtk"Response Body
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X DELETE "https://example.com/watchlist/watch_01m0fqhdr0e31ray1qxa2x5vtk"Add a watchlist entry POST
Adds a person to your watchlist. Give a name and a phone number, an ID number or both. When a visit is created for, or someone checks in as, a person matching an entry (on name, allowing for spelling differences, phone number or ID number), Agoo holds the visit, alerts your security team silently and fires `watchlist.matched`. The visitor, the host and the kiosk aren't told why. Every watchlist read and change is in the audit trail. Leave `site_ids` empty to watch for the person at every site. **Scope:** `watchlist:write` · **Plan:** Pro and Enterprise in live mode; every plan in test mode.
List roll calls GET
Returns roll calls, newest first, with their live counts. Use `GET /roll-calls/{rollcall_id}` for the list of people. **Scope:** `rollcalls:read` · **Plan:** Pro and Enterprise in live mode; every plan in test mode.