v1Resources/Reviews/patchHide or unhide a review keyword

Hide or unhide a review keyword

Requires an active agency user with Reviews and owning-client access. Supply exactly one of locationId or clientId. Keywords are trimmed and lowercased. POST adds a 3–128 character keyword, up to 10 custom keywords per scope, and requests background semantic tagging, which can consume generation capacity. Check queued and warning:tagging_not_queued; the keyword remains saved if enqueueing fails. DELETE removes the custom keyword and its tags. PATCH requires hide:true or false and changes visibility without deleting reviews. DELETE/PATCH accept existing keywords of 1–128 characters.

patch/api/v1/reviews/topic-trends/keywords
reviews:write
Request body
locationIdstringoptional
clientIdstringoptional
keywordstringrequired
hidebooleanrequired
Response
dataobjectoptional
Errors
400The request is missing a required parameter or is otherwise malformed.
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
404The resource wasn't found, or doesn't belong to your agency.
409The legacy location configuration conflicts with another scope and cannot be changed.
429Too many requests. Retry after the number of seconds in the Retry-After header.
503The review operation could not be completed.
patch/api/v1/reviews/topic-trends/keywords
Your API key
Request body*
{
  "data": {
    "custom": [
      "friendly staff"
    ],
    "hidden": [
      "parking"
    ],
    "customMeta": {
      "friendly staff": {
        "at": "2026-02-01T10:00:00.000Z",
        "byName": "Jamie Rivera",
        "byUserId": "cm_user_1"
      }
    }
  }
}

Guides that use this resource