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

/segment/restore

Description

API call to restore deleted segments


  • Only available for customer admin and for admin.

  • All the segment ids should be from one site group.


Request

The request object has the following fields:

Name

Type

Required

Description

segmentIds

Array Of String

Yes

All the segment ids need to be restored

siteGroupId

String

Yes

The site group identifier of restorable segments

Response

The response object has the following fields:

Name

Type

Description

messages

Array of String

Array of messages about segments: seccessfully restored, skipped, failed.

Examples

Bash
$ python cx.py /segment/restore?admin=true '{"siteGroupId":"10501", "segmentIds": ["1y2hkqwvv58ls", "1y2hkqwvv58ln", "1y2hkqwvv58lp"]}'
{
 "messages": [
 "Segments successfully restored: [1y2hkqwvv58ls]",
 "Restore failed for segment: 1y2hkqwvv58ln. Error message",
 "Segment [1y2hkqwvv58lp] is from another siteGroup. SiteGroupId: [12345]. Skipped"
 ]
}

Last updated: