Customer Data Platform Segment

Get, update, or delete a segment.

Resource

Available version

56.0

Requires Chatter

HTTP methods

GET, PATCH, DELETE

Response body for GET

Customer Data Platform Segment Container Output

Request body for PATCH

Root XML tag

<cdpSegment>

JSON example

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
`description`	String	Segment description.	Optional	55.0
`developerName`	String	Segment developer name.	Required for POST Not supported for PATCH	55.0
`includeDbt`	Customer Data Platform Segment Dbt Input	Customer Data Platform 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
`segmentType`	String	Type of segment. Value is: `Dbt`—Data build tool	Required for POST Not supported for PATCH	55.0

Response body for PATCH

Customer Data Platform Segment Output

Response for DELETE

204: Successful Delete

Connect REST API Developer Guide