/site/group/create | Documentation

Creates a new site group.

The user must be authenticated and have write access to all sites added to the site group.

Request

The request object has the following fields:

Name	Type	Required	Description
`name`	String	Yes	Site group name. Maximum 32 characters.
`description`	String	No	Site group description. Maximum 250 characters.
`siteIds`	Array of String	No	Array of site identifiers that will be included in the created site group.

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.
`segmentAutoDeletionEnabled`	Boolean	Enables segment auto deletion by `minAudienceSize` and `durationForMinAudienceSize`.
`updateRelatedSegments`	Boolean	Activating this option leads to updating and/or deleting related segments in case of automatic deletion of the main segments of the site group.
`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`)

Examples

Bash

$ python cx.py /site/group/create '{"name":"Example","description":"Example site group"}'
{
 "id": "9222300742653756873"
}

Last updated: December 28, 2023