Wordlists
A wordlist holds your own terms, such as competitor names or banned phrases, matched on normalised text so that case, lookalike characters and digit-for-letter substitutions do not hide a term. A template that enables it gets the policy wordlist/<slug>.
Endpoints
- GET/v1/wordlistsList wordlists
- POST/v1/wordlistsCreate a wordlist
- GET/v1/wordlists/{id}Retrieve a wordlist
- PATCH/v1/wordlists/{id}Update a wordlist
- DELETE/v1/wordlists/{id}Delete a wordlist
- GET/v1/wordlists/{id}/termsList terms
- POST/v1/wordlists/{id}/termsAdd terms
- DELETE/v1/wordlists/{id}/termsRemove terms
The wordlist object
A list of your own terms, matched on normalised text and scored as its own policy.
{
"object": "wordlist",
"id": "wl_5pLeuA3L3i0NVotCEeX1nk",
"project_id": "prj_0TBAgHGtdMketrbltGFHuk",
"slug": "competitors",
"policy": "wordlist/competitors",
"name": "Competitors",
"description": "Other marketplaces that listings should not send buyers to.",
"mode": "block",
"match_preset": "same_word",
"language": null,
"enabled": true,
"entries_count": 5,
"created_at": "2026-10-08T08:44:28.840Z",
"updated_at": "2026-10-08T08:49:34.839Z"
}Attributes
object"wordlist"Always
wordlist.idstringId of the wordlist:
wl_plus 22 base62 characters.slugstringThe slug in the policy key. Set when the wordlist is created and never changed.
policystringThe policy key under which the wordlist is scored and returned:
wordlist/<slug>.namestringDisplay name.
modeenumWhat a match means:
block(a matched term is a violation),require(the violation is that no term matched) orcollect(matches are reported with a score of 0, and a match still fires the policy's trigger unless the template observes the wordlist).One of
blockrequirecollectmatch_presetenumHow close a word must be to a single-word term to match:
exact(1.0),same_word(0.9),similar(0.75) ornearest(0.6), as a similarity from 0 to 1.One of
exactsame_wordsimilarnearestlanguagestring or nullA language code for your own reference, or null. It does not change matching.
enabledbooleanWhether the list is matched. A disabled list scores 0 on the templates that enable it.
entries_countintegerNumber of terms in the list.
project_idstringId of the project:
prj_plus 22 base62 characters.descriptionstringA note on what the list is for, or null.
created_attimestampWhen the wordlist was created, ISO 8601 in UTC.
updated_attimestampWhen the wordlist last changed, ISO 8601 in UTC.
Something missing or unclear on this page? Write to support@useinfrared.com.