- Overview
- What's New in V8?
- Changelog
- Open API Specification 3.0.0 (OAS)
- API Directory
- API Collection
- APIs and References
- OAuth
- API Limits and Credits
- Compliance
- Zoho CRM SDKs
- Metadata APIs
- Customization
- Process Automation
- Security control
- Roles
- Profiles
- Territories
- GETTerritories
- POSTTerritories
- PUTTerritories
- DELETETerritories
- POSTTransfer and Delete Territories
- GETChild Territories of a Territory
- GETTerritories Assigned
- GETAssociated User Count
- GETRetrieve User details Associated with a Territory
- PUTAssociate Users with Territory
- POSTRemove Territories of Records
- POSTAssign Territories to Records
- DELETEDisassociate Users from Territory
- Export Audit Log
- Portals
- Data Sharing
- GETData Sharing Rules
- POSTData Sharing Rules
- PUTData Sharing Rules
- DELETEData Sharing Rules
- GETData Sharing Settings
- PUTData Sharing Settings
- PUTActivate Data Sharing Rule
- DELETEDeactivate Data Sharing Rule
- POSTRerun Data Sharing Rules
- GETData Sharing Rules Summary
- POSTData Sharing Rules Summary Filter
- POSTSearch Data Sharing Rules
- Company Settings
- Zia
- Core APIs
- Records
- Merge Records
- Share Records
- Mail Merge
- Services
- Appointments
- Appointments Rescheduled History
- Fields Attachments
- Meeting Cancel
- Notes
- Mass Actions
- Related Records
- External ID
- Emails
- Subforms
- Linking Modules
- Others
- Bulk APIs
- Composite API
- Query API
- Notification APIs
Update a User Group
Purpose
To update a user group.
Endpoints
- PUT /settings/user_groups/{user_group_ID}
Request Details
Request URL
{api-domain}/crm/{version}/settings/user_groups/{user_group_id}
Header
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
Scope
scope=ZohoCRM.settings.user_groups.UPDATE
Sample Request
Copiedcurl "https://www.zohoapis.com/crm/v8/settings/user_groups/3652397000009949005"
-X PUT
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"Input JSON
- namestring, mandatory
The name of the user group. Accepts alphanumeric characters. Note that the name must be unique for each group.
- descriptionstring, optional
The description of the user group.
- sourceJSON array, mandatory
Each JSON object in this array consists of the following keys:
- type - string, mandatory - The type of member you want to add to the user group. The possible values are users, roles, groups, and territories.
- source - JSON object, mandatory - The API name and ID of the user, group, role, or territory you want to add to the user group. If your "type" is "roles", you must only give the details of the role, here.
- subordinates - boolean, optional - When you type is "roles" or "territories", this key represents whether you want to assign the subordinate roles or child territories to the user group, too.
- _delete - boolean, mandatory when you want to delete a member - The value "true" deletes the member from the user group.
Sample Input
Copied{
"user_groups": [
{
"name": "test group",
"description": "my group",
"sources": [
{
"source": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
},
"type": "users"
},
{
"source": {
"name": "Manager",
"id": "3652397000000026008"
},
"type": "roles",
"subordinates": true
},
{
"source": {
"name": "New York",
"id": "3652397000007622003"
},
"type": "territories",
"subordinates": true
},
{
"source": {
"name": "Deborah Gill",
"id": "3652397000000281001"
},
"type": "users",
"_delete":true
}
]
}
]
}Show full
Show less
Possible Errors
- INVALID_DATAHTTP 400
- The role or territory ID is invalid.
- The user group ID is invalid.
Resolution: Refer to the "details" key in the response for the exact error and rectify it accordingly.
- NO_PERMISSIONHTTP 403
You do not have permission to update a user group.
Resolution: Contact your administrator to obtain the "Manage Groups" permission to be able to create a user group.
Sample Response
Copied{
"user_groups": [
{
"code": "SUCCESS",
"details": {
"id": "3652397000009949005"
},
"message": "User Group Updated successfully",
"status": "success"
}
]
}© 2025, Zoho Corporation Pvt. Ltd. All Rights Reserved.