Skip to content

Remove terms

DELETE/v1/wordlists/{id}/termsKey scope write

Removes terms from a wordlist by id. Ids that are not in the list are ignored.

Needs a key with the write scope. Authentication

curl -X DELETE https://api.useinfrared.com/v1/wordlists/wl_5KcJIqikl2tXcuKJHvpzgO/terms \
  -H "Authorization: Bearer $INFRARED_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "ids": ["wle_1to4eNsIbVFc5HBXZpn8Xl"]
  }'
200 OKResponse
{
  "deleted": 1,
  "entries_count": 2
}

Path parameters

idstringRequired

Id of the wordlist: wl_ plus 22 base62 characters.

Request body

idsarray of stringsRequired

Ids of the terms to remove, 1 to 5,000 of them, each wle_ plus 22 base62 characters.

Returns

An object with deleted, the number of terms removed, and entries_count, the number left in the list.

  • 200 OKAn object

Errors

404
not_found

The key's project has no wordlist with this id.

422
validation_error

ids is empty, has more than 5,000 items, or holds a value that is not a wle_ id.

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.