createSegments

POST {{baseUrl}}/ssot/segments?dataspace=<string>

Create a segment in Data Cloud.

Available Version: 55.0

Root XML tag: <cdpSegment>

Request Params

KeyDatatypeRequiredDescription
dataspacestringName 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, the dataSpace request body parameter is used.
  • In API version 58.0, if neither this parameter nor the dataSpace request body property is specified, the default 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

KeyDatatypeRequiredDescription
Content-Typestring

RESPONSES

status: OK

{&quot;apiName&quot;:&quot;\u003cstring\u003e&quot;,&quot;dataSpace&quot;:&quot;\u003cstring\u003e&quot;,&quot;description&quot;:&quot;\u003cstring\u003e&quot;,&quot;developerName&quot;:&quot;\u003cstring\u003e&quot;,&quot;displayName&quot;:&quot;\u003cstring\u003e&quot;,&quot;excludeCriteria&quot;:&quot;\u003cstring\u003e&quot;,&quot;includeCriteria&quot;:&quot;\u003cstring\u003e&quot;,&quot;includeDbt&quot;:{&quot;models&quot;:[{&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;sql&quot;:&quot;\u003cstring\u003e&quot;},{&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;sql&quot;:&quot;\u003cstring\u003e&quot;}]},&quot;lookalikeCriteria&quot;:{&quot;additionalPopulation&quot;:&quot;\u003cint64\u003e&quot;,&quot;seedSegmentId&quot;:&quot;\u003cstring\u003e&quot;},&quot;marketSegmentDefinitionId&quot;:&quot;\u003cstring\u003e&quot;,&quot;marketSegmentId&quot;:&quot;\u003cstring\u003e&quot;,&quot;nextPublishDateTime&quot;:&quot;\u003cstring\u003e&quot;,&quot;publishInterval&quot;:&quot;\u003cstring\u003e&quot;,&quot;publishScheduleEndDate&quot;:&quot;\u003cstring\u003e&quot;,&quot;publishScheduleStartDateTime&quot;:&quot;\u003cstring\u003e&quot;,&quot;publishStatus&quot;:&quot;\u003cstring\u003e&quot;,&quot;segmentMembershipDmo&quot;:{&quot;historyTable&quot;:&quot;\u003cstring\u003e&quot;,&quot;latestTable&quot;:&quot;\u003cstring\u003e&quot;,&quot;profileTable&quot;:&quot;\u003cstring\u003e&quot;},&quot;segmentMembershipTable&quot;:&quot;\u003cstring\u003e&quot;,&quot;segmentOnApiName&quot;:&quot;\u003cstring\u003e&quot;,&quot;segmentOnId&quot;:&quot;\u003cstring\u003e&quot;,&quot;segmentStatus&quot;:&quot;\u003cstring\u003e&quot;,&quot;segmentType&quot;:&quot;\u003cstring\u003e&quot;}