Newer Version Available

This content describes an older version of this product. View Latest

CdpSegment Class

Create, delete, get, and update segments.

Namespace

ConnectApi

CdpSegment Methods

The following are methods for CdpSegment. All methods are static.

createSegment(input)

Create a segment.

API Version

55.0

Requires Chatter

No

Signature

public static ConnectApi.CdpSegmentOutput createSegment(ConnectApi.CdpSegmentInput input)

Parameters

input
Type: ConnectApi.CdpSegmentInput
A ConnectApi.CdpSegmentInput class.

Return Value

Type: ConnectApi.CdpSegmentOutput

deleteSegment(segmentId)

Delete a segment.

API Version

55.0

Requires Chatter

No

Signature

public static Void deleteSegment(String segmentId)

Parameters

segmentId
Type: String
ID of the segment.

Return Value

Type: Void

getSegment(segmentId)

Get a segment.

API Version

55.0

Requires Chatter

No

Signature

public static ConnectApi.CdpSegmentContainerOutput getSegment(String segmentId)

Parameters

segmentId
Type: String
ID of the segment.

querySegments()

Get segments.

API Version

55.0

Requires Chatter

No

Signature

public static ConnectApi.CdpSegmentContainerOutput getSegments()

updateSegment(segmentId, input)

Update a segment.

API Version

55.0

Requires Chatter

No

Signature

public static ConnectApi.CdpSegmentOutput updateSegment(String segmentId, ConnectApi.CdpSegmentInput input)

Parameters

segmentId
Type: String
ID of the segment.
input
Type: ConnectApi.CdpSegmentInput
A ConnectApi.CdpSegmentInput class with the updates.

Return Value

Type: ConnectApi.CdpSegmentOutput