API - Update Group

Update Group

This API is used to update group name, code, description and custom properties.

API Details

Signature of API call

connection.invokeApi(String uri, String realUserName, Map<String, String> requestParameters);

See details about invoking API in general


Parameter 1 - URI



Parameter 2 - UserName

Username of the user (for my groups) and site admin(for site groups)


Parameter 3 - Request Parameters

Name Value
dispatch updateGroup
xml true
id Group ID
groupName New Name of the group
domain New Group Code
description New Group Description
maxUsers New value for maxUsers
allowedEmailDomains New value for allowed email domains
customProperties Group custom properties having key and value pairs



Response on successfully updating the group

HTTP Response Code = HttpServletResponse.SC_OK

Response XML

<response code="0">
            <![CDATA[Group updated successfully]]>



Code Snippet

/* Check API Call for detail */

Map<String, String> parameters = new HashMap<String, String>();
String result = connection.invokeApi("groupService.do", "adminusername", parameters);
private void populateMapForGroupUpdate(Map<String, String> parameters) {
    parameters.put("dispatch", "updateGroup");
    parameters.put("xml", String.valueOf(true));
    parameters.put("id", "<Group ID>");
    parameters.put("groupName", "New Group Name");
    parameters.put("domain", "Europe");
    parameters.put("description", "New group updated under by API");
    parameters.put("maxMembers", String.valueOf(50));
    parameters.put("allowedEmailDomains", “acme.com, mycompany.com”);