Updates a static custom group's name, description, or member resources

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

Updates a static custom group (groupCategory=1). Requires groupId and resourceIds. Important: Do not include groupType or groupCategory in the request body — these are immutable after creation and will be rejected. The resourceIds field is required and replaces the entire member list — pass the full desired member set on every update; partial omission is not supported. Prerequisites: Call Get Available Resources to discover valid resource IDs for the replacement member list.

Request URL

https://{serverurl}/api/1.4/customgroup/updateCg

Scope

DesktopCentralCloud.Common.UPDATECopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory
application/jsonapplication/jsonCopied!

Must be application/json. Request body must be valid JSON.

AcceptstringMandatory
application/jsonapplication/jsonCopied!

Must be application/json. Only JSON responses are supported.

- Request Body

application/json
JSON object
Hide Sub-Attributes
groupIdlongMandatory

Resource ID of the group to update. Fetch from Retrieve All Custom Groups.

groupNamestringOptional

Updated group name. Max 100 chars. Must be unique.

descriptionstringOptional

Updated description. Max 250 chars.

resourceIdsarrayMandatory

Complete replacement member list. Pass the entire desired member set on every update — partial omission is not supported. Fetch IDs from Get Available Resources.

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request POST \
  --url https://appdomain/api/1.4/customgroup/updateCg \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"groupId":301,"resourceIds":[101,102,103,104,105]}'
Show full

Sample Request Body

Replace the entire member list and update description.

Copied!
  {
    "groupName": "Windows Servers",
    "groupId": 301,
    "description": "Updated - Production and Staging Windows Servers",
    "resourceIds": [
      101,
      102,
      103,
      104,
      105
    ]
  }
                
Show full

Response Parameters

- HTTP code 200

Response Body - application/json


JSON object
Hide Sub-Attributes
message_typestring

Always 'updateCg' for this endpoint.

message_responseJSON object

Response payload container.

Show Sub-Attributes
updatecgJSON object

Response payload.

Show Sub-Attributes
cgResourceIdstring

Resource ID of the updated group (returned as string). Use as cgId in Delete CG, or as groupId in a subsequent Update Static CG / Update Static Unique CG call.

groupNamestring

Current name after update.

invalidResourceIdsarray

[Conditional] Array of resource IDs that were not found or not valid. Present only when some submitted resourceIds are invalid.

message_versionstring

API version: '1.4'.

statusstring

'success' when the request completed without errors.

- HTTP code 404

Response Body - application/json


JSON object
Hide Sub-Attributes
message_typestring

Always 'updateCg' for this endpoint.

message_versionstring

API version: '1.4'.

statusstring

Always 'error' for error responses.

error_codestring

'70506' (CG_INVALID_DETAILS_TO_UPDATE).

error_descriptionstring

Resolved I18N message: 'No such Custom Group found.' -- group does not exist, user is out of scope, or group is invalid for current product edition.

- HTTP code 412

Response Body - application/json


JSON object
Hide Sub-Attributes
message_typestring

Always 'updateCg' for this endpoint.

message_versionstring

API version: '1.4'.

statusstring

Always 'error' for error responses.

error_codestring

'70501' (CG_CREATE_UPDATE_PARAMS_MISSING), '70502' (CG_DUPLICATE_NAME), '70509' (CG_DUMMY_CG_RENAME), '70503' (CG_NULL_CRITERIA_PATTERN), '70517' (CG_INVALID_CRITERIA_PATTERN), '70508' (CG_MORE_COMPUTERS_DUMMY_CG), '70513' (CG_INVALID_CREATION_MODE).

error_descriptionstring

Resolved I18N message varies by error code: 'Required parameters are missing to create/update Custom Group.' (70501), 'Custom group name is already in use.' (70502), 'All Features Group cannot be renamed.' (70509), 'Criteria pattern is empty.' (70503), 'Invalid criteria pattern.' (70517), 'Computer limit exceeded for free edition.' (70508), 'Only manually created Custom Group is allowed to be accessed using external apis.' (70513).

- HTTP code 500

Response Body - application/json


JSON object
Hide Sub-Attributes
message_typestring

Always 'updateCg' for this endpoint.

message_versionstring

API version: '1.4'.

statusstring

Always 'error' for error responses.

error_codestring

Internal error code: '1003' (INTERNAL_ERROR).

error_descriptionstring

Resolved I18N message, typically: An internal error occurred while processing the request.

Possible Response Codes

200HTTP code
404HTTP code
412HTTP code
500HTTP code

Sample Response: HTTP 200

Group details and membership updated.

Copied!
  {
    "message_type": "updateCg",
    "message_response": {
      "updatecg": {
        "groupName": "Windows Servers",
        "cgResourceId": "301"
      }
    },
    "message_version": "1.4",
    "status": "success"
  }
                
Show full

Static group updated but some submitted resource IDs were not found.

Copied!
  {
    "message_type": "updateCg",
    "message_response": {
      "updatecg": {
        "groupName": "Windows Servers",
        "invalidResourceIds": [
          999,
          998
        ],
        "cgResourceId": "301"
      }
    },
    "message_version": "1.4",
    "status": "success"
  }
                
Show full

Sample Response: HTTP 404

Group ID does not exist or user lacks access.

Copied!
  {
    "error_description": "No such Custom Group found.",
    "message_type": "updateCg",
    "error_code": "70506",
    "message_version": "1.4",
    "status": "error"
  }
                
Show full

Sample Response: HTTP 412

Required field is missing — groupId, or resourceIds for a static update.

Copied!
  {
    "error_description": "Required parameters are missing to create/update Custom Group.",
    "message_type": "updateCg",
    "error_code": "70501",
    "message_version": "1.4",
    "status": "error"
  }
                
Show full

Sample Response: HTTP 500

Unexpected server-side failure during update.

Copied!
  {
    "error_description": "An internal error occurred while processing the request.",
    "message_type": "updateCg",
    "error_code": "1003",
    "message_version": "1.4",
    "status": "error"
  }
                
Show full

Duration: 1 minute | Threshold: 30 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.