Apex Reference Guide
jNote: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.
ConnectApi.CdpSegmentInput
| Property | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| additionalMetadata | Map<String, String> | Map of additional metadata. | Optional for creating a segment Not supported for updating a segment |
55.0 |
| dataSpace | String | Segment dataspace. In API version 59.0 and later, this property is not available. Use the dataspace request parameter instead. | Optional | 57.0–58.0 |
| description | String | Segment description. | Optional | 55.0 |
| developerName | String | Segment developer name. | Required for creating a segment Not supported for updating a segment |
55.0 |
| displayName | String | Segment display name. | Optional | 57.0 |
| includeDbt | ConnectApi.CdpSegmentDbtInput | Segment data build tool. | Required | 55.0 |
| publishSchedule | ConnectApi.PublishSchedule | Publish refresh schedule.
Values are:
|
Optional | 55.0 |
| publishScheduleEndDate | String | Date indicating the end of the publish schedule. | Optional if publishSchedule isn’t specified | 55.0 |
| publishScheduleStartDateTime | String | Datetime indicating the start of the publish schedule. | Optional if publishSchedule isn’t specified | 55.0 |
| segmentOnApiName | String | API name of the SegmentOn entity. | Optional | 57.0 |
| segmentType | ConnectApi.SegmentType | Type of segment.
Value is:
|
Required for creating a segment Not supported for updating a segment |
55.0 |