Update a wordlist
PATCH/v1/wordlists/{id}Key scope write
Updates the properties sent and leaves the others unchanged. The slug, and with it the policy key, cannot be changed.
Needs a key with the write scope. Authentication
Path parameters
idstringRequiredId of the wordlist:
wl_plus 22 base62 characters.
Request body
namestringA name for the list, 1 to 200 characters.
descriptionstringA note on what the list is for, up to 2,000 characters. Null clears it.
modeenumWhat a match means:
block,requireorcollect, as described for creating a wordlist.One of
blockrequirecollectmatch_presetenumHow close a word must be to a single-word term to match:
exact,same_word,similarornearest, as described for creating a wordlist.One of
exactsame_wordsimilarnearestlanguagestringA language code of up to 8 characters, for your own reference. Null clears it.
enabledbooleanWhether the list is matched. A disabled list scores 0 on the templates that enable it.
Returns
The updated wordlist. Results are cached for 6 hours per identical text, so a change can take that long to reach text that was moderated before it.
- 200 OKA wordlist object
Errors
- 404
not_foundThe key's project has no wordlist with this id.
- 422
validation_errorA value is empty or too long,
modeormatch_presetis not one of the listed values, or the body has an unknown key.
Every endpoint can also answer the errors any request can meet: a missing key, a rate limit, a malformed body. Errors
Something missing or unclear on this page? Write to support@useinfrared.com.