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

/segment/composition-tree/update

API call to update a segment composition tree (SCT).

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

id

String

Yes

The id of the SCT to update.

siteGroupId

String

No

The site group identifier to store the SCT under.

name

String

No

Max 250 characters.

description

String

No

Max 250 characters.

active

Boolean

No

Activate/deactivate the SCT.

node

Node Objects

No

The

segment composition tree nodes

the tree consists of.

Response

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

Name

Type

Description

id

String

The identifier for the SCT

siteGroupId

String

The site group identifier to which this SCT belongs

name

String

The name of this SCT

description

String

A description for this SCT

node

Node objects

The segment composition tree nodes the tree consists of.

Examples

Bash
$ /config/bin/cx.py /segment/composition-tree/update '{"siteGroupId":"1352607337759980390","id":"c1a91f31-b42f-4870-aa04-e136988b1de0","name":"test2","node":{"or":[{"and":[{"segmentId":"aa9o0y4vujjh"},{"segmentId":"aaki3g4izc5a"}]},{"segmentId":"aavlzlrn5j9b"}]}}'
{
 "id": "c1a91f31-b42f-4870-aa04-e136988b1de0",
 "name": "test2",
 "siteGroupId": "1352607337759980390",
 "node": {
 "or": [
 {
 "and": [
 {
 "segmentId": "aa9o0y4vujjh"
 },
 {
 "segmentId": "aaki3g4izc5a"
 }
 ]
 },
 {
 "segmentId": "aavlzlrn5j9b"
 }
 ]
 }
}

Last updated: