POST https://api.hivemoderation.com/api/v1/watchlist/remove

Removes one or more terms from an existing watchlist.

Example Request

curl -X POST https://api.hivemoderation.com/api/v1/watchlist/remove \
  -H "Authorization: token <API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "watchlist": "my-watchlist",
    "terms": ["example term", "another term"]
  }'

Request

Headers

Header	Type	Required	Description
Authorization	string	Yes	API key from Hive Moderation Dashboard (per-application).
Content-Type	string	Yes	Submit JSON data in the request body.

Request Body Parameters

Parameter	Type	Required	Description
watchlist	string	Yes	The unique API field name identifying the target watchlist.
terms	array	Yes	Array of strings listing terms to be removed.

Notes

Terms are normalized to lowercase before matching.
Terms not found in the watchlist are returned under non_existent_terms, and will not cause the request to fail.

Responses

Response Fields

Field	Type	Always Returned	Description
message	string	Yes	Human-readable result summary.
watchlist	string	Yes	The watchlist API field name provided in the request.
removed_terms	array	Yes	Terms successfully removed from the watchlist.
non_existent_terms	array	Yes	Terms that were not found in the watchlist.
failed_terms	array	Yes	Terms that could not be processed due to an error.

Example Success (200 OK)

{
  "message": "Successfully removed from list. Some terms may not exist in list.",
  "watchlist": "my-watchlist",
  "removed_terms": ["example term"],
  "non_existent_terms": ["another term"],
  "failed_terms": []
}

Example Error Response (400 Bad Request)

{
  "error": true,
  "status": 400,
  "error_code": "PARAM_REQUIRED",
  "message": "watchlist is required.",
  "show_alert": false
}

Common Errors

Status Code	Error Code	Description
400	PARAM_REQUIRED	Missing required parameter or invalid type.
403	INVALID_API_KEY	No application matches the provided API key.