Manage a Custom Watchlist Record

Add, update, or soft-delete a record in a custom watchlist. The operation is determined by the action_type field:

  • add: Create a new record in the watchlist.
  • update: Update an existing record.
  • delete: Soft-delete a record. The record stays on the list, but its status changes from Active to Inactive.

All operations are keyed by record.id. The list itself must already exist — create it in the RiskOS™ Dashboard before calling this endpoint.

📘

Note:

The custom watchlist must already exist before you call this endpoint. Create it in the RiskOS™ Dashboard (Reason Codes & Lists > Custom Watchlist), then use the list's ID as the listId path parameter. For setup steps, see Custom Watchlist.

Path Params
uuid
required

The unique ID of the custom watchlist to add, update, or remove a record from. The list must already exist (created in the RiskOS™ Dashboard).

Body Params
string
enum
required

The action to take on this record — add, update, or delete.
Note: delete is a soft delete; the record stays on the list, but its status changes from Active to Inactive.

Allowed:
record
object
required

The record details you're adding, updating, or deleting.

Responses

Language
URL
LoadingLoading…
Response
Choose an example:
application/json