Connect REST API Developer Guide
jNewer Version Available
Salesforce CDP Segments
- Resource
-
- Available version
- 55.0
- Requires Chatter
- No
- HTTP methods
- GET, POST
- Response body for GET
- Salesforce CDP Segment Container Output
- Request body for POST
-
- Root XML tag
- <cdpSegment>
- JSON example
-
- Properties
-
Name Type Description Required or Optional Available Version additionalMetadata Map<String, String> Map of additional metadata. Optional 55.0 description String Segment description. Optional 55.0 developerName String Segment developer name. Required 55.0 includeDbt Salesforce CDP Segment Dbt Input Salesforce CDP segment data build tool. Required 55.0 publishSchedule String Publish refresh schedule. Values are: - Four—Refreshes every four hours.
- NoRefresh—Doesn’t refresh.
- Six—Refreshes every six hours.
- Twelve—Refreshes every twelve hours.
- TwentyFour—Refreshes every twenty-four hours.
- Two—Refreshes every two hours.
Optional 55.0 publishScheduleEndDate String Date indicating the end of the publish schedule. Optional if publishSchedule isn’t specified or if NoRefresh is specified 55.0 publishScheduleStartDateTime String Datetime indicating the start of the publish schedule. Optional if publishSchedule isn’t specified or if NoRefresh is specified 55.0 segmentType String Type of segment. Value is: - Dbt—Data build tool
Required 55.0
- Response body for POST
- Salesforce CDP Segment Output