createSegments
POST {{baseUrl}}/ssot/segments?dataspace=<string>
Create a segment in Data Cloud.
Available Version: 55.0
Root XML tag: <cdpSegment>
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
dataspace | string | Name of the dataspace in which to perform the action. User must have permission to this dataspace. Default is the default dataspace. |
- In API version 58.0, if specified, this parameter overrides the
dataSpace
request body property. If this parameter is unspecified, thedataSpace
request body parameter is used. - In API version 58.0, if neither this parameter nor the
dataSpace
request body property is specified, thedefault
dataspace is used. - In API version 59.0 and later, use this parameter. The
dataSpace
request body property is not available.
Available Version: 58.0 |
Request Body
{"developerName"=>"ConnectSegment20", "displayName"=>"", "description"=>"This is a connect API segment", "segmentOnApiName"=>"", "publishSchedule"=>"One", "publishScheduleEndDate"=>"", "publishScheduleStartDateTime"=>"", "includeDbt"=>{"models"=>{"models"=>[{"name"=>"m1", "sql"=>"select ssot__Individual__dlm.ssot__Id__c from ssot__Individual__dlm where ssot__Individual__dlm.ssot__FirstName__c='john'"}]}}, "segmentType"=>"Dbt"}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string |
RESPONSES
status: OK
{"apiName":"\u003cstring\u003e","dataSpace":"\u003cstring\u003e","description":"\u003cstring\u003e","developerName":"\u003cstring\u003e","displayName":"\u003cstring\u003e","excludeCriteria":"\u003cstring\u003e","includeCriteria":"\u003cstring\u003e","includeDbt":{"models":[{"name":"\u003cstring\u003e","sql":"\u003cstring\u003e"},{"name":"\u003cstring\u003e","sql":"\u003cstring\u003e"}]},"lookalikeCriteria":{"additionalPopulation":"\u003cint64\u003e","seedSegmentId":"\u003cstring\u003e"},"marketSegmentDefinitionId":"\u003cstring\u003e","marketSegmentId":"\u003cstring\u003e","nextPublishDateTime":"\u003cstring\u003e","publishInterval":"\u003cstring\u003e","publishScheduleEndDate":"\u003cstring\u003e","publishScheduleStartDateTime":"\u003cstring\u003e","publishStatus":"\u003cstring\u003e","segmentMembershipDmo":{"historyTable":"\u003cstring\u003e","latestTable":"\u003cstring\u003e","profileTable":"\u003cstring\u003e"},"segmentMembershipTable":"\u003cstring\u003e","segmentOnApiName":"\u003cstring\u003e","segmentOnId":"\u003cstring\u003e","segmentStatus":"\u003cstring\u003e","segmentType":"\u003cstring\u003e"}