Salesforce CDP Segment

Get, update, or delete a segment.

Resource

1/ssot/segments/segmentId

Available version

55.0

Requires Chatter

HTTP methods

GET, PATCH, DELETE

Response body for GET

Salesforce CDP 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	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 PATCH

Salesforce CDP Segment Output

Response for DELETE

204: Successful Delete

Connect REST API Developer Guide

Salesforce CDP Segment