We’ve migrated our documentation to a new site, which means some URLs have changed.
Audience
Audience
Breadcrumbs

/segment/group/update

Description

API call to update custom segment group.


  • The user must be authenticated and have read permissions to the siteGroup.


Request

The request object has the following fields:

Name

Type

Required

Description

siteGroupId

String

Yes

The site group identifier to store the segment group under

group

String

Yes

New custom segment group name in case of update with id.
Old custom segment group name in case of update with newGroup

id

Number

Yes if newGroup is undefined

The identifier for group

newGroup

String

Yes if id is undefined

New custom segment group name

NOTE: There are two ways to update custom group name:

  • Use id as custom group identifier and group for new name

  • Use group as old custom group name and newGroup for new name

Response

The response object for a successful query has the following fields:

Name

Type

Description

id

Number

The identifier for this group

group

String

Segment group name

siteGroupId

String

The site group identifier to which this segment group belongs

createdAt

String

The creation time. Only available for customer admin and for admin (?customerAdmin=true, ?admin=true)

createdBy

String

User name of person who created custom segment group. Only available for customer admin and for admin (?customerAdmin=true, ?admin=true)

lastChangedAt

String

The last changing time. Only available for customer admin and for admin (?customerAdmin=true, ?admin=true)

lastUpdatedBy

String

User name of last person who modified custom segment group. Only available for customer admin and for admin (?customerAdmin=true, ?admin=true)

Examples

Bash
$ python cx.py /segment/group/update '{"siteGroupId":"10501", "id":123, "group":"new group name"}'
 {
 "id":"123",
 "group":"new group name",
 "siteGroupId":"10501",
 "createdBy": "user.user@mail.com", 
 "createdAt": "2022-08-16T05:12:45.982Z", 
 "lastChangedBy": "user.user@mail.com", 
 "lastChangedAt": "2022-08-16T05:12:45.982Z"
 }
 
 python cx.py /segment/group/update '{"siteGroupId":"10501", "group":"old group name", "newGroup":"new group name"}'
 {
 "id":"123",
 "group":"new group name",
 "siteGroupId":"10501",
 "createdBy": "user.user@mail.com", 
 "createdAt": "2022-08-16T05:12:45.982Z", 
 "lastChangedBy": "user.user@mail.com", 
 "lastChangedAt": "2022-08-16T05:12:45.982Z"
 }

Last updated: