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
patron_id
string
Yes
The unique identifier for the patron.
user_tags_api_fields
array
Yes
Array of tag api_field strings to remove.
Notes:
If a tag api_field does not exist in the application, it will be reported under failed, not non_existent.
If a tag is not currently on the patron, it will be reported under non_existent, not failed. This is a no-op.
Unlike the add endpoint, the patron must already exist. A 400 is returned if not found.
Response messages now reflect all possible dynamic outcomes (see table below).
Responses
Response Fields
Field
Type
Always Returned
Description
message
string
Yes
Human-readable result summary.
patron_id
string
Yes
The patron ID provided in the request.
removed_tag_ids
array
Yes
api_fields successfully removed from the patron.
non_existent_tag_ids
array
Yes
api_fields not present on the patron, no-op.
failed
array
Yes
api_fields that could not be processed, including error message.
Updated Response Messages
/user_tags/remove
Scenario
Message
All tags removed successfully
Successfully removed tags from patron.
Removed + some don't exist
Successfully removed tags from patron. Some tags may not exist on patron.
Removed + some failed
Some tags were removed. Some tags failed to remove.
Removed + some don't exist + some failed
Some tags were removed. Some tags may not exist on patron. Some tags failed to remove.
All tags don't exist
No tags were removed. All tags do not exist on patron.
All tags don't exist + some failed
No tags were removed. Some tags do not exist on patron. Some tags failed to remove.
All tags failed to remove
No tags were removed. All tags failed to remove.
Example Success
{
"message": "Successfully removed tags from patron. Some tags may not exist on patron.",
"patron_id": "user_abc123",
"removed_tag_ids": ["vip"],
"non_existent_tag_ids": ["newsletter"],
"failed": []
}
Example Error Response
{
"error": true,
"status": 400,
"error_code": "INVALID_PATRON",
"message": "This Patron(patron-dne-222) does not exist",
"show_alert": false
}
