# Creates a static custom group with explicit member resources Creates a static custom group (`groupCategory=1`) where members are explicitly specified via resource IDs. **Required:** `groupName`, `groupType`, `groupCategory`, `resourceIds`. Group name must be unique and max 100 characters. **Prerequisites:** Call [Get Available Resources](https://www.manageengine.com/products/desktop-central/custom-groups-get-available-resources.html) to discover valid resource IDs to include in `resourceIds`. ## Endpoints **POST** `/api/1.4/customgroup/addCg` ## Request URL `https://{serverurl}/api/1.4/customgroup/addCg` ## Scope `DesktopCentralCloud.Common.UPDATE` ## Header `Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52` ## Request Parameters ### Request Headers - **Content-Type** (string, Mandatory): `application/json` Must be application/json. Request body must be valid JSON. - **Accept** (string, Mandatory): `application/json` Must be application/json. Only JSON responses are supported. ### Request Body **application/json** JSON object with the following fields: - **groupName** (string, Mandatory) Name for the new group. Must be unique. Max 100 chars. > Forbidden characters: `\ : ; < > ? * " | & # % /` - **groupCategory** (string, Mandatory) Must be `1` for static groups. - **groupType** (string, Mandatory) `1` = Computers, `2` = Users. - **description** (string, Optional) Group description. Max 250 chars. Double quotes not allowed. - **resourceIds** (array, Mandatory) Array of long resource IDs to add as members. Fetch IDs from [Get Available Resources](https://www.manageengine.com/products/desktop-central/custom-groups-get-available-resources.html). ## Sample Request ### Curl ```bash curl --request POST \ --url https://appdomain/api/1.4/customgroup/addCg \ --header 'Accept: application/json' \ --header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' \ --header 'Content-Type: application/json' \ --data '{"groupName":"Windows Servers","groupType":1,"groupCategory":1,"resourceIds":[101,102,103]}' ``` ### Java ```java import java.net.URI; import java.net.http.HttpClient; import java.net.http.HttpRequest; import java.net.http.HttpResponse; import java.io.IOException; import java.net.http.HttpTimeoutException; public class Main { public static void main(String[] args) { HttpRequest request = HttpRequest.newBuilder() .uri(URI.create("https://appdomain/api/1.4/customgroup/addCg")) .header("Content-Type", "application/json") .header("Accept", "application/json") .header("Authorization", "Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52") .method("POST", HttpRequest.BodyPublishers.ofString("{\"groupName\":\"Windows Servers\",\"groupType\":1,\"groupCategory\":1,\"resourceIds\":[101,102,103]}")) .build(); HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString()); System.out.println(response.body()); } } ``` ### Python ```python import http.client conn = http.client.HTTPSConnection("appdomain") payload = "{\"groupName\":\"Windows Servers\",\"groupType\":1,\"groupCategory\":1,\"resourceIds\":[101,102,103]}" headers = { 'Content-Type': "application/json", 'Accept': "application/json", 'Authorization': "Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52" } conn.request("POST", "/api/1.4/customgroup/addCg", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) ``` ### Deluge ```javascript headersMap = Map(); headersMap.put("Content-Type", "application/json"); headersMap.put("Accept", "application/json"); data=Map(); data.put("groupName","value"); data.put("groupType","value"); data.put("groupCategory","value"); data_resourceIds=List(); data.put("resourceIds",data_resourceIds); response = invokeUrl [ url: "https://appDomain/api/1.4/customgroup/addCg" type: POST headers: headersMap body: data connection: connection_name ] info response; ``` ### PowerShell ```powershell $headers=@{} $headers.Add("Content-Type", "application/json") $headers.Add("Accept", "application/json") $headers.Add("Authorization", "Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52") $response = Invoke-WebRequest -Uri 'https://appdomain/api/1.4/customgroup/addCg' -Method POST -Headers $headers -ContentType 'application/json' -Body '{"groupName":"Windows Servers","groupType":1,"groupCategory":1,"resourceIds":[101,102,103]}' ``` ## Sample Request Body ### Create a static computer group with three server members. ```json { "groupName": "Windows Servers", "groupType": 1, "groupCategory": 1, "description": "Production Windows Server machines", "resourceIds": [ 101, 102, 103 ] } ``` ### Create a static user group with two members. ```json { "groupName": "HR Users", "groupType": 2, "groupCategory": 1, "description": "Human Resources department users", "resourceIds": [ 501, 502 ] } ``` ## Response Parameters ### HTTP code 200 **Response Body – application/json** JSON object: - **message_type** (string) Always `addCg` for this endpoint. - **message_response** (JSON object) Response payload container. - **addcg** (JSON object) Response payload. - **cgResourceId** (string) Newly assigned resource ID (returned as string). Use as `cgId` in [Delete CG](https://www.manageengine.com/products/desktop-central/custom-groups-delete-cg.html), or as `groupId` in the request body of [Update Static CG](https://www.manageengine.com/products/desktop-central/custom-groups-update-static-cg.html) or [Update Static Unique CG](https://www.manageengine.com/products/desktop-central/custom-groups-update-static-unique-cg.html). - **groupName** (string) Name of the created group (echoed from request). - **groupCategory** (string) Numeric category as string: `'1'` = Static, `'5'` = Static Unique. - **groupType** (string) Group type as numeric string: `'1'` for Computers, `'2'` for Users. Not the display name. - **invalidResourceIds** (array) Conditional. Array of resource IDs that were not found or not valid. Present only when some submitted `resourceIds` are invalid. - **message_version** (string) API version: `'1.4'`. - **status** (string) `'success'` when the request completed without errors. ### Sample Response: HTTP 200 #### Static computer group created with assigned resource ID. ```json { "message_type": "addCg", "message_response": { "addcg": { "groupName": "Windows Servers", "groupType": "1", "groupCategory": "1", "cgResourceId": "301" } }, "message_version": "1.4", "status": "success" } ``` #### Static group created but some submitted resource IDs were not found. ```json { "message_type": "addCg", "message_response": { "addcg": { "groupName": "Windows Servers", "groupType": "1", "groupCategory": "1", "invalidResourceIds": [ 999, 998 ], "cgResourceId": "301" } }, "message_version": "1.4", "status": "success" } ``` ### HTTP code 412 **Response Body – application/json** JSON object: - **message_type** (string) Always `addCg` for this endpoint. - **message_version** (string) API version: `'1.4'`. - **status** (string) Always `'error'` for error responses. - **error_code** (string) `'70501'` (CG_CREATE_UPDATE_PARAMS_MISSING), `'70502'` (CG_DUPLICATE_NAME), `'70504'` (CG_INVALID_GROUP_TYPE), `'70505'` (CG_INVALID_GROUP_CATEGORY), `'70503'` (CG_NULL_CRITERIA_PATTERN), `'70517'` (CG_INVALID_CRITERIA_PATTERN), `'70508'` (CG_MORE_COMPUTERS_DUMMY_CG), `'70513'` (CG_INVALID_CREATION_MODE). - **error_description** (string) Resolved I18N message varies by error code. ### Sample Response: HTTP 412 #### Required field is missing. ```json { "error_description": "Required parameters are missing to create/update Custom Group.", "message_type": "addCg", "error_code": "70501", "message_version": "1.4", "status": "error" } ``` #### A group with this name already exists. ```json { "error_description": "Custom group name is already in use.", "message_type": "addCg", "error_code": "70502", "message_version": "1.4", "status": "error" } ``` ### HTTP code 500 **Response Body – application/json** JSON object: - **message_type** (string) Always `addCg` for this endpoint. - **message_version** (string) API version: `'1.4'`. - **status** (string) Always `'error'` for error responses. - **error_code** (string) `'1003'` (INTERNAL_ERROR). - **error_description** (string) Typically: `An internal error occurred while processing the request.` ### Sample Response: HTTP 500 ```json { "error_description": "An internal error occurred while processing the request.", "message_type": "addCg", "error_code": "1003", "message_version": "1.4", "status": "error" } ``` ## Possible Response Codes - **200** - **412** - **500** ## API Rate Limits **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.