CRM360° CustomerApi Documentation

Customer - Segmentation

Manage the segment types entities.

Required HTTP Headers

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

Functions

Entity Properties

Name Type Is Mandatory
SegmentationId Int32
Label String
Identifier String
SourceId Int16
SegmentationTypeId Int16
DeletionFlag Boolean
ProcessDate DateTime
Segments Collection of Segment
SegmentTypes Collection of SegmentType
Source Source

Examples

Select all Segmentations

https://customerapi.fts-crm360.com/data/Segmentations()
HttpMethod : GET
Json Result :
[ { "SegmentationId" : "95", "Label" : "YwBuuFchN", "Identifier" : "OEXQK", "SourceId" : "9", "SegmentationTypeId" : "1", "DeletionFlag" : "True", "ProcessDate" : "2002-05-10T00:00:00" }, { "SegmentationId" : "25", "Label" : "jPEbLz", "Identifier" : "x sKgT", "SourceId" : "1", "SegmentationTypeId" : "3", "DeletionFlag" : "True", "ProcessDate" : "1999-05-29T00:00:00" }, ... ]

Select Segmentation by Id

https://customerapi.fts-crm360.com/data/Segmentations(95)
HttpMethod : GET
Json Result :
{ "SegmentationId" : "64", "Label" : "Cu78 yueP2wIB", "Identifier" : "Jzf8RiSYwyVCjDO", "SourceId" : "8", "SegmentationTypeId" : "3", "DeletionFlag" : "True", "ProcessDate" : "2016-03-07T00:00:00" }

Create a Segmentation

https://customerapi.fts-crm360.com/data/Segmentations()
HttpMethod : POST
Json Post :
{
"Label" : "LYnSDpbU 5oiIzI",
"Identifier" : "yt1FRq9I",
"SourceId" : "6",
"SegmentationTypeId" : "9",
"DeletionFlag" : "True",
"ProcessDate" : "2014-08-18T00:00:00"
}
            
Informations :
- Non mandatory fields are optional for Json Post

Update a Segmentation

https://customerapi.fts-crm360.com/data/Segmentations(95)
HttpMethod : PUT
Json Post :
{
"SegmentationId" : "26",
"Label" : "k3 WfwLN3n",
"Identifier" : "8j1Ix4",
"SourceId" : "7",
"SegmentationTypeId" : "9",
"DeletionFlag" : "False",
"ProcessDate" : "1997-08-14T00:00:00"
}
            
Informations :
- Non mandatory fields are optional for Json Post

Patch a Segmentation

https://customerapi.fts-crm360.com/data/Segmentations(95)
HttpMethod : PATCH
Json Post :
{
"Identifier" : "AnYg dqG xDbV",
"SourceId" : "7"
}
            
Informations :
- Non mandatory fields are optional for Json Post

Delete a Segmentation

https://customerapi.fts-crm360.com/data/Segmentations(95)
HttpMethod : DELETE

Translate a Segmentation label

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