/site/group/update | Documentation

Update a site group

The user must be authenticated and have write permissions to the site group.

Request

The request object has the following fields:

Name	Type	Required	Description
`siteGroupId`	String	Yes	The identifier of the site group to update.
`name`	String	No	Site group name. Maximum 32 characters.
`description`	String	No	Site group description. Maximum 250 characters.
`permissions`	Array of Permission objects	No	Only permitted for customer admin. Requires the request parameters `?experimental=true&customerAdmin=true`. Configure access to this site group for the listed users. The users not listed will not have their permissions modified.
`siteIds`	Array of String	No	Array of site identifiers.
`childSiteGroupIds`	Array of String	No	Only permitted for customer admin. Requires the request parameters `?experimental=true&customerAdmin=true`. Configure site group hierarchy.
`minAudienceSize`	Integer	No	Only permitted for customer admin. Minimum audience size. Segments with an audience less than that minAudienceSize during durationForMinAudienceSize will be deleted automatically.
`durationForMinAudienceSize`	Integer	No	Only permitted for customer admin. Duration for minAudienceSize. Segments with an audience less than that minAudienceSize during durationForMinAudienceSize will be deleted automatically.
`segmentAutoDeletionEnabled`	Boolean	No	Only permitted for customer admin. Enables segment auto deletion by `minAudienceSize` and `durationForMinAudienceSize`.
`updateRelatedSegments`	Boolean	Only permitted for customer admin. Activating this option leads to updating and/or deleting related segments in case of automatic deletion of the main segments of the site group.

Fields that are not specified will not be updated. To clear a field, set it to an empty string/array.

It is important to note that an Array of Site Identifiers will overwrite the existing sites connected to the Site Group.

So if you want to add a new siteId to an existing group, you must run the command with all the currently attached siteIds PLUS the siteId of the new site you want to add.

Permission

Permission management is only available for customer admins and requires request parameters ?experimental=true&customerAdmin=true.

The permission object has the following fields:

Name	Type	Required	Description
`username`	String	Yes	The user to update the permissions for. The username must exist already.
`read`	Boolean	No	True if the user should have read access to this site group (default is true).
`write`	Boolean	No	True if the user should have write access to this site group (default is false).

If neither read nor write is set to true, the permission for the user will be removed.

Response

The response object has the following fields:

Name	Type	Description
`id`	String	Site group identifier.
`name`	String	Site group name. (max 32 characters)
`description`	String	Site group description.
`siteIds`	Array of String	Array of site identifiers that are directly linked to this site group.
`permissions`	Array of Object	Array of permission objects specifying the users that have access to the site group and their permission. Note: This will only contain the current user except for customer admin.
`parentSiteGroupIds`	List of Strings	List of parent site groups for which the user has read permissions.
`minAudienceSize`	Integer	Minimum audience size. Segments with an audience less than that minAudienceSize during durationForMinAudienceSize will be deleted automatically.
`durationForMinAudienceSize`	Integer	Duration for minAudienceSize. Segments with an audience less than that minAudienceSize during durationForMinAudienceSize will be deleted automatically.
`createdAt`	String	The creation time. Only available for customer admin (`?customerAdmin=true`)
`createdBy`	String	User name of person who created user. Only available for customer admin (`?customerAdmin=true`)
`lastChangedAt`	String	The last changing time. Only available for customer admin (`?customerAdmin=true`)
`lastUpdatedBy`	String	User name of last person who modified user. Only available for customer admin (`?customerAdmin=true`)
`segmentAutoDeletionEnabled`	Boolean	Enables segment auto deletion by `minAudienceSize` and `durationForMinAudienceSize`. Only available for customer admin (`?customerAdmin=true`)

Examples

Bash

$ python cx.py /site/group/update '{"siteGroupId":"9222300742653756873","name":"New group name"}'
{
 "id": "9222300742735526873"
}
$ python cx.py /site/group '{"siteGroupId":"9222300742653756873"}'
{
 "siteGroups": [
 {
 "id": "9222300742653756873",
 "name": "New group name",
 "description": "Example site group",
 "siteIds": [
 "9222300742735526873"
 ],
 "permissions": [
 {
 "username": "example@cxense.com",
 "read": true,
 "write": true
 }
 ]
 }
 ]
}

Last updated: December 28, 2023