Beam Help
Get help now

How-to · Zoho DESK

How to remove users from a label in Zoho Desk

Unassign users from specific labels quickly via API.

Removing users from a label in Zoho Desk's Help Center can be done via two complementary API endpoints — one that strips labels from a specific user, and another that removes multiple users from a given label in one call.


Why this matters


Help Center labels help segment your community users for targeted content, permissions, or workflows. When a user's role or status changes, you'll need to clean up their label assignments to keep your segmentation accurate. Equally, if you're retiring or reorganising a label, bulk-removing all associated users first is good housekeeping before deletion.


Step-by-step


There are two supported approaches depending on whether you're working from the user's perspective or the label's perspective.


---


Approach A — Remove labels from a specific user


Step 1. Gather the three identifiers you'll need: your helpcenterid (the ID of the Help Center portal), the userid of the community member whose labels you want to modify, and the label IDs you intend to remove. These can be retrieved from earlier list/get calls against the Zoho Desk Help Center API.


Step 2. Send a DELETE request to the following endpoint, substituting your real values for the path parameters:


DELETE /api/v1/helpcenter/{helpcenter_id}/users/{user_id}/labels

Pass any label-specific filter data through the p (parameters) dictionary in the request body. [1]


Step 3. In Python, the call looks like this:


result = desk_api.remove_labels_from_user(
    helpcenter_id="your_helpcenter_id",
    user_id="target_user_id",
    p={"labelIds": ["label_id_1", "label_id_2"]}
)

A successful response confirms the labels have been unlinked from that user. [1]


---


Approach B — Remove users from a specific label


Step 1. Collect your helpcenterid and the labelid of the label you want to depopulate. You'll also need the user IDs to be removed, passed via the p parameter dictionary.


Step 2. Issue a DELETE request to:


DELETE /api/v1/helpcenter/{helpcenter_id}/labels/{label_id}/users

This targets the label directly and removes whichever users you specify. [2]


Step 3. The equivalent Python call is:


result = desk_api.remove_users_under_a_label(
    helpcenter_id="your_helpcenter_id",
    label_id="target_label_id",
    p={"userIds": ["user_id_1", "user_id_2"]}
)

This is the preferred route when you need to clean up a label across many users at once. [2]


---


OAuth scopes required


Your connected Zoho Desk OAuth token must include the appropriate scopes. At minimum, ensure Desk.settings.ALL or the relevant Desk.settings.DELETE scope is present in your token configuration, as label management falls under the settings surface of the API. [3]


---


Common pitfalls


  • Confusing the two endpoints: removelabelsfromuser (Approach A) is user-centric — you target a user and strip labels from them. removeusersundera_label (Approach B) is label-centric — you target a label and strip users from it. Using the wrong one won't cause an error per se, but it may not produce the result you expect. [1][2]

  • Don't accidentally delete the label itself: There are separate endpoints — DELETE /api/v1/helpcenter/{helpcenterid}/labels/{labelid} and DELETE /api/v1/helpcenter/{helpcenter_id}/labels — that permanently delete labels rather than just removing users from them. Make sure you're calling the user-removal endpoints, not the label-deletion ones. [5][6]

  • Missing helpcenterid: This is not the same as your Zoho Desk orgid. The Help Center has its own identifier. If your integration auto-discovers the org ID on first run, double-check that the helpcenter_id is also stored and passed correctly. [7]

  • Don't mix up badge removal with label removal: There is a similarly structured endpoint at DELETE /api/v1/helpcenter/{helpcenterid}/users/{userid}/badges for removing badges — a different concept entirely. Verify you're hitting the /labels path, not /badges. [4]

---


What to check


  • Confirm the user's label list is updated by calling a GET on that user's profile after the DELETE and verifying the target labels no longer appear.
  • Verify your OAuth token scopes include the necessary Desk.settings permissions; an insufficient-scope error will return a 401/403 and the removal will silently fail. [3]
  • Check you haven't inadvertently deleted the label itself — if other users still need that label, use only the user-removal endpoints documented above, not the label-deletion endpoints. [5][6]

---


*Beam Help provides independent expert support for Zoho products and is not official Zoho support. Always test API calls in a sandbox environment before running them against production data.*

Sources cited

  1. [1] DELETE /api/v1/helpcenter/{helpcenter_id}/users/{user_id}/labels
  2. [2] DELETE /api/v1/helpcenter/{helpcenter_id}/labels/{label_id}/users
  3. [3] config.py
  4. [4] DELETE /api/v1/helpcenter/{helpcenter_id}/users/{user_id}/badges
  5. [5] DELETE /api/v1/helpcenter/{helpcenter_id}/labels/{label_id}
  6. [6] DELETE /api/v1/helpcenter/{helpcenter_id}/labels
  7. [7] server.py: get_zoho_api
  8. [8] DELETE /api/v1/helpcenter/{helpcenter_id}/groups/{group_id}/users
Remove Users From Label | Beam Help — Beam Help