Blocklist Entries

Create blocklist entry

Creates a new blocklist entry. The screening engine cache is refreshed automatically so the new entry takes effect immediately.

post/api/blocklist-entries

Request

  • Base URL: http://localhost:4100
  • URL: http://localhost:4100/api/blocklist-entries
  • Auth: none required

Request body

activeboolean
added_by_idstring uuid nullable
entry_type'exact' | 'regex' required
reasonstring nullable
scope'first_name' | 'last_name' | 'company_name' required
tenant_idstring uuid required
termstring required

Example request

{
  "active": false,
  "added_by_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
  "entry_type": "exact",
  "reason": "",
  "scope": "first_name",
  "tenant_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
  "term": ""
}

Changes

No recorded changes to this operation across all 4 revisions of this API.