Data Cloud Segment

Get, update, or delete a segment.

Resource

1/ssot/segments/segmentApiName

Available version

56.0

Requires Chatter

HTTP methods

GET, PATCH, DELETE

Response body for GET

Data Cloud Segment Container Output

Request body for PATCH

Root XML tag

<cdpSegment>

JSON example

1{
2"developerName": "ConnectSegment20",
3"description": "This is a connect API segment",
4"includeDbt": {
5   "models": {
6      "models": [
7         {
8         "name": "m1",
9         "sql": "select ssot__Individual__dlm.ssot__Id__c from ssot__Individual__dlm where ssot__Individual__dlm.ssot__FirstName__c='john'"
10         }
11      ]
12   }
13   },
14"segmentType": "Dbt"
15}

Properties

Name	Type	Description	Required or Optional	Available Version
`additionalMetadata`	Map<String, String>	Map of additional metadata.	Optional for POST Not supported for PATCH	55.0
`dataSpace`	String	Segment data space.	Optional	57.0
`description`	String	Segment description.	Optional	55.0
`developerName`	String	Segment developer name.	Required for POST Not supported for PATCH	55.0
`displayName`	String	Segment display name.	Optional	57.0
`includeDbt`	Data Cloud Segment Dbt Input	Segment data build tool.	Required	55.0
`publishSchedule`	String	Publish refresh schedule. Values are: `Twelve`—Refreshes every twelve hours. `TwentyFour`—Refreshes every twenty-four hours.	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`	String	Type of segment. Value is: `Dbt`—Data build tool After a segment is created, the segment type can’t be changed.	Required for POST Not supported for PATCH	55.0

Response body for PATCH

Data Cloud Segment Output

Response for DELETE

204: Successful Delete

Connect REST API Developer Guide

Data Cloud Segment