CRM360° CustomerApi Documentation

Customer - SegmentType

Manage the segment types entities.

Required HTTP Headers

  • X-Crm360Api-Token
  • X-Crm360Api-CustomerName
  • X-Crm360Api-DatabaseAlias

Functions

Entity Properties

Name Type Is Mandatory
SegmentTypeId Int16
Label String
Identifier String
SourceId Int16
SegmentationId Int32
SegmentationIdentifier String
DeletionFlag Boolean
Segments Collection of Segment
Segmentation Segmentation
Source Source

Examples

Select all SegmentTypes

https://customerapi.fts-crm360.com/data/SegmentTypes()
HttpMethod : GET
Json Result :
[ { "SegmentTypeId" : "8", "Label" : "qeEBpWCfXZg6gtsp", "Identifier" : "zJhvIj", "SourceId" : "4", "SegmentationId" : "48", "SegmentationIdentifier" : "0i VbH", "DeletionFlag" : "True" }, { "SegmentTypeId" : "4", "Label" : "T RQq XYZv", "Identifier" : "JbIW8rP6Vg", "SourceId" : "7", "SegmentationId" : "19", "SegmentationIdentifier" : "M8iCDyFX", "DeletionFlag" : "False" }, ... ]

Select SegmentType by Id

https://customerapi.fts-crm360.com/data/SegmentTypes(8)
HttpMethod : GET
Json Result :
{ "SegmentTypeId" : "4", "Label" : "theiuwK6tu", "Identifier" : "Fr eaKaFyHE cAc", "SourceId" : "3", "SegmentationId" : "32", "SegmentationIdentifier" : "p 3Fxo MrLkVwc", "DeletionFlag" : "True" }

Create a SegmentType

https://customerapi.fts-crm360.com/data/SegmentTypes()
HttpMethod : POST
Json Post :
{
"Label" : "12DkW67KiNnh",
"Identifier" : "gRc1U",
"SourceId" : "1",
"SegmentationId" : "74",
"SegmentationIdentifier" : "4VEOdOgbXnd7KlP",
"DeletionFlag" : "False"
}
            
Informations :
- Non mandatory fields are optional for Json Post

Update a SegmentType

https://customerapi.fts-crm360.com/data/SegmentTypes(8)
HttpMethod : PUT
Json Post :
{
"SegmentTypeId" : "3",
"Label" : "Ctii 3KJ5HeaYyt",
"Identifier" : "8tfHbspF1 CEWqMGE",
"SourceId" : "4",
"SegmentationId" : "68",
"SegmentationIdentifier" : "bVULDT",
"DeletionFlag" : "False"
}
            
Informations :
- Non mandatory fields are optional for Json Post

Patch a SegmentType

https://customerapi.fts-crm360.com/data/SegmentTypes(8)
HttpMethod : PATCH
Json Post :
{
"SegmentationIdentifier" : "86OrOTngOH",
"SegmentationId" : "27"
}
            
Informations :
- Non mandatory fields are optional for Json Post

Delete a SegmentType

https://customerapi.fts-crm360.com/data/SegmentTypes(8)
HttpMethod : DELETE

Translate a SegmentType label

https://customerapi.fts-crm360.com/data/SegmentTypes(8)/Label
HttpMethod : GET
Required Fields :
Http Header for language : X-Crm360Api-Language-3