Groups resouce

Site group management - Update site group

OVERVIEW


This API method updates the name of an existing group in a site

Request URI

PUT   /api/3/sites/{siteid}/groups/{groupid}

Request Parameter

Parameter Name Value Description
siteid Integer The ID of the site. The siteid can be obtained by calling the Get Site list API
groupid Integer The ID of the site group. The groupid can be obtained by calling the Get all site groups API

 

Request Body

Provide the name of the site group in the request body to update the group title. 

<group>

     <name>HighQ group1</name>

</group>

 

Response 

The API returns a 200 OK if successful otherwise an error object and error code.

 

URI Parameters

Parameter Value Description
groupid integer

The ID of the site group The groupid can be obtained by calling Get all site groups 

siteid

 integer The ID for the site.

1) To get site id use following API Get site list
name String 

The group name cannot contain the following characters:  \  / : * ? " < > | 

Comments


0 Comments

Last Updated: Jun 09,2023