--- schema_version: "1" id: 971a68a85ecf3d6d89c952dfc8d161a4db11f08d08e41fc9de0189342cab1b14 title: ConnectApi.CdpSegmentInput collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/apexref/apex_connectapi_input_cdp_segment.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_connectapi_input_cdp_segment.htm source_site: developer.salesforce.com content_type: documentation content_hash: 7cdd7cf872328dd83cfae2de25f0081815b1a7d4f423e0239b23e0a62ccac238 description: Segment input. --- # ConnectApi.CdpSegmentInput Segment input.
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.​CdpSegment​DbtInput Segment data build tool. Required 55.0
publishSchedule ConnectApi.​PublishSchedule Publish refresh schedule. Values are:
  • One—Refreshes every hour. Used to rapidly publish UI and DBT-based segments.
  • Four—Refreshes every four hours. Used to rapidly publish UI and DBT-based segments.
  • Twelve—Refreshes every twelve hours.
  • TwentyFour—Refreshes every twenty-four hours.
Optional 55.0
publishSchedule​EndDate String Date indicating the end of the publish schedule. Optional if publishSchedule isn’t specified 55.0
publishSchedule​StartDateTime 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:
  • Dbt—Data build tool
After a segment is created, the segment type can’t be changed. 		Required for creating a segment

Not supported for updating a segment

 55.0