Groups resouce

Site group management - Add site group

OVERVIEW

This API method adds a new group to the site

Request URI

POST   /api/3/sites/{siteid}/groups

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

 

Request Body

Provide a below request body.

<group>
     <name>HighQ group1</name>
    <copypermissionsfrom>11</copypermissionsfrom> <!-- (The ID of the group from which the file permissions should be copied from. The group ID can be obtained by a call to Get all site groups API call) -->

</group>

Notes

  • copypermissionsfrom is Mandatory field it is used to copy group permission.
  • Please set the value of copypermissionsfrom  to -1 when you don't want to copy any other groups permissions.
  • The group name cannot contain the following characters:  \  / : * ? " < > | 

Response 

The response returns group objects with the group id populated in the group object. 

 

URI Parameters

Request Parameters Value Description
siteid integer The ID for the site.
1) To get site id use following API Get site list

Comments


3 Comments


Fernando Deleon thank you pointing this out, we have updated the documentation accordingly.


Ok for those wondering if you dont want to use copypermissionsfrom you need to do this



    APIGroup

    -1

:=\

ie add the id of -1

 

Last Updated: Nov 08,2024