CustomerApi Odata Help Page

Customer - Segment

Manage the segments linked to contacts for the current user's allowed zones.

Required HTTP Headers

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

Functions

Create
Read
Update
Delete

Entity Properties

Name	Type	Is Mandatory
SegmentId	Int32
ContactId	Int32
ContactIdentifier	String
SegmentationId	Int32
SegmentationIdentifier	String
SegmentTypeId	Int16
SegmentTypeIdentifier	String
PurchaseGoodId	Int32
PurchaseGoodIdentifier	String
PurchaseGoodCategoryId	Int16
PurchaseGoodCategoryIdentifier	String
Value	String
SourceId	Int16
FreeField1	String
FreeField2	String
FreeField3	String
FreeField4	String
FreeField5	String
FreeFieldDateTime1	DateTime
FreeFieldDateTime2	DateTime
FreeFieldDateTime3	DateTime
FreeFieldDateTime4	DateTime
FreeFieldDateTime5	DateTime
FreeFieldNumber1	Decimal
FreeFieldNumber2	Decimal
FreeFieldNumber3	Decimal
FreeFieldNumber4	Decimal
FreeFieldNumber5	Decimal
FreeFieldBoolean1	Boolean
FreeFieldBoolean2	Boolean
FreeFieldBoolean3	Boolean
FreeFieldBoolean4	Boolean
FreeFieldBoolean5	Boolean
DeletionFlag	Boolean
SegmentType	SegmentType
Segmentation	Segmentation
Contact	Contact
PurchaseGood	PurchaseGood
Source	Source
PurchaseGoodCategory	PurchaseGoodCategory

Examples

Select all Segments
https://customerapi.fts-crm360.com/data/Segments()
HttpMethod : GET                                                                                       
Json Result : 

[
{
"SegmentId" : "94",
"ContactId" : "60",
"ContactIdentifier" : "h e6vDjHDxZY6C",
"SegmentationId" : "11",
"SegmentationIdentifier" : "yxHSUFhnLcVE",
"SegmentTypeId" : "5",
"SegmentTypeIdentifier" : "wZHDquzhHxi",
"PurchaseGoodId" : "39",
"PurchaseGoodIdentifier" : "2gLMD",
"PurchaseGoodCategoryId" : "1",
"PurchaseGoodCategoryIdentifier" : "ZWzTTac1",
"Value" : "RteooA Q1YXpPpWu",
"SourceId" : "9",
"FreeField1" : "qF QQ",
"FreeField2" : "PBZlz",
"FreeField3" : "OQ8y0DDv 1h6Wrsk",
"FreeField4" : "scjXZyv",
"FreeField5" : "AbeYmmZbFIGrczRp",
"FreeFieldDateTime1" : "2000-05-11T00:00:00",
"FreeFieldDateTime2" : "2013-07-17T00:00:00",
"FreeFieldDateTime3" : "2019-02-01T00:00:00",
"FreeFieldDateTime4" : "2011-10-17T00:00:00",
"FreeFieldDateTime5" : "1997-02-09T00:00:00",
"FreeFieldNumber1" : "9636872.348",
"FreeFieldNumber2" : "5218664.832",
"FreeFieldNumber3" : "5356979.292",
"FreeFieldNumber4" : "7927282.779",
"FreeFieldNumber5" : "3273654.971",
"FreeFieldBoolean1" : "True",
"FreeFieldBoolean2" : "False",
"FreeFieldBoolean3" : "True",
"FreeFieldBoolean4" : "False",
"FreeFieldBoolean5" : "True",
"DeletionFlag" : "False"
},
{
"SegmentId" : "5",
"ContactId" : "71",
"ContactIdentifier" : "Ly8ULDfBXsvZoEU1",
"SegmentationId" : "28",
"SegmentationIdentifier" : "N7ZR4e0Y6YuEc",
"SegmentTypeId" : "8",
"SegmentTypeIdentifier" : "7hHT2gOHbBS6",
"PurchaseGoodId" : "67",
"PurchaseGoodIdentifier" : "vQkTF w",
"PurchaseGoodCategoryId" : "4",
"PurchaseGoodCategoryIdentifier" : "3cezIHSRP56rhLi A9",
"Value" : "8OmjKMLHIxW sknO0",
"SourceId" : "4",
"FreeField1" : "F JwC udMDB4D07",
"FreeField2" : "qR4Ul8 Jf35",
"FreeField3" : "F58sBT2z",
"FreeField4" : "djiau9CG3RJwK777C",
"FreeField5" : "I  PJF",
"FreeFieldDateTime1" : "2009-12-13T00:00:00",
"FreeFieldDateTime2" : "2005-12-06T00:00:00",
"FreeFieldDateTime3" : "2003-08-26T00:00:00",
"FreeFieldDateTime4" : "1998-04-22T00:00:00",
"FreeFieldDateTime5" : "2004-08-01T00:00:00",
"FreeFieldNumber1" : "8792627.498",
"FreeFieldNumber2" : "9916675.991",
"FreeFieldNumber3" : "7927882.459",
"FreeFieldNumber4" : "4798152.667",
"FreeFieldNumber5" : "3623219.664",
"FreeFieldBoolean1" : "False",
"FreeFieldBoolean2" : "False",
"FreeFieldBoolean3" : "False",
"FreeFieldBoolean4" : "True",
"FreeFieldBoolean5" : "False",
"DeletionFlag" : "True"
},
...
]

Select Segment by Id
https://customerapi.fts-crm360.com/data/Segments(94)
HttpMethod : GET                                                                                       
Json Result : 

{
"SegmentId" : "58",
"ContactId" : "24",
"ContactIdentifier" : "y9T39fS P",
"SegmentationId" : "61",
"SegmentationIdentifier" : "j0WMwJ",
"SegmentTypeId" : "8",
"SegmentTypeIdentifier" : "jw0l G25V NI78Txw5",
"PurchaseGoodId" : "71",
"PurchaseGoodIdentifier" : "v1BsAex",
"PurchaseGoodCategoryId" : "2",
"PurchaseGoodCategoryIdentifier" : "GV Bpq",
"Value" : "7YexFl8KBcHlg",
"SourceId" : "6",
"FreeField1" : "1apKstIkVUq",
"FreeField2" : "NezFRRw Ya6DJ41pi",
"FreeField3" : "Krgqe9Yd9",
"FreeField4" : "zJcaxurOX1UvvC fk",
"FreeField5" : "y1dB9",
"FreeFieldDateTime1" : "1999-04-08T00:00:00",
"FreeFieldDateTime2" : "2023-11-03T00:00:00",
"FreeFieldDateTime3" : "2003-06-23T00:00:00",
"FreeFieldDateTime4" : "2011-01-03T00:00:00",
"FreeFieldDateTime5" : "1995-01-30T00:00:00",
"FreeFieldNumber1" : "8783916.356",
"FreeFieldNumber2" : "4224258.976",
"FreeFieldNumber3" : "1585293.723",
"FreeFieldNumber4" : "5527461.187",
"FreeFieldNumber5" : "5219667.185",
"FreeFieldBoolean1" : "True",
"FreeFieldBoolean2" : "False",
"FreeFieldBoolean3" : "True",
"FreeFieldBoolean4" : "True",
"FreeFieldBoolean5" : "True",
"DeletionFlag" : "True"
}

Create a Segment
https://customerapi.fts-crm360.com/data/Segments()
HttpMethod : POST                                                                                                
Json Post :
{
"ContactId" : "91",
"ContactIdentifier" : "I8rzFKL4",
"SegmentationId" : "48",
"SegmentationIdentifier" : "gc1GB",
"SegmentTypeId" : "2",
"SegmentTypeIdentifier" : "c01iRR5tAZ9QvCvt21",
"PurchaseGoodId" : "6",
"PurchaseGoodIdentifier" : "B0wtnMAV a6dv",
"PurchaseGoodCategoryId" : "9",
"PurchaseGoodCategoryIdentifier" : "ckrZ3Y",
"Value" : "y5tu wu",
"SourceId" : "9",
"FreeField1" : "f3mEI6D",
"FreeField2" : "ktkcefvI",
"FreeField3" : "QRKowpr9y4dAjPb",
"FreeField4" : "ePHS UpmITpjUaN",
"FreeField5" : "0FdsEVvN5GVBlOAcHx",
"FreeFieldDateTime1" : "2002-09-17T00:00:00",
"FreeFieldDateTime2" : "2013-03-22T00:00:00",
"FreeFieldDateTime3" : "2020-02-25T00:00:00",
"FreeFieldDateTime4" : "2015-01-23T00:00:00",
"FreeFieldDateTime5" : "2022-04-07T00:00:00",
"FreeFieldNumber1" : "6655126.475",
"FreeFieldNumber2" : "2577625.948",
"FreeFieldNumber3" : "9619324.649",
"FreeFieldNumber4" : "4945158.328",
"FreeFieldNumber5" : "5941157.428",
"FreeFieldBoolean1" : "False",
"FreeFieldBoolean2" : "True",
"FreeFieldBoolean3" : "False",
"FreeFieldBoolean4" : "True",
"FreeFieldBoolean5" : "False",
"DeletionFlag" : "True"
}
            
Informations : 
 - Non mandatory fields are optional for Json Post

Update a Segment
https://customerapi.fts-crm360.com/data/Segments(94)
HttpMethod : PUT                                                                                                
Json Post :
{
"SegmentId" : "55",
"ContactId" : "60",
"ContactIdentifier" : "zsE6uHM",
"SegmentationId" : "6",
"SegmentationIdentifier" : "rFUMrlZA",
"SegmentTypeId" : "3",
"SegmentTypeIdentifier" : "1ueCYkLoemmC8NIZEY",
"PurchaseGoodId" : "4",
"PurchaseGoodIdentifier" : "90fdrDgjA3Z5un",
"PurchaseGoodCategoryId" : "7",
"PurchaseGoodCategoryIdentifier" : "TorWhdsbloH",
"Value" : "CRfA p",
"SourceId" : "9",
"FreeField1" : "OAXUC",
"FreeField2" : "nmMrUUduFasqEe",
"FreeField3" : "C2C6af",
"FreeField4" : "XX6EruKRQWS51FO5",
"FreeField5" : "zmULEUTkc",
"FreeFieldDateTime1" : "2021-02-08T00:00:00",
"FreeFieldDateTime2" : "2000-04-09T00:00:00",
"FreeFieldDateTime3" : "1999-04-13T00:00:00",
"FreeFieldDateTime4" : "2004-08-07T00:00:00",
"FreeFieldDateTime5" : "2006-08-12T00:00:00",
"FreeFieldNumber1" : "6293873.675",
"FreeFieldNumber2" : "8244261.897",
"FreeFieldNumber3" : "2825316.538",
"FreeFieldNumber4" : "9299689.842",
"FreeFieldNumber5" : "1287499.948",
"FreeFieldBoolean1" : "False",
"FreeFieldBoolean2" : "False",
"FreeFieldBoolean3" : "False",
"FreeFieldBoolean4" : "False",
"FreeFieldBoolean5" : "True",
"DeletionFlag" : "False"
}
            
Informations : 
 - Non mandatory fields are optional for Json Post

Patch a Segment
https://customerapi.fts-crm360.com/data/Segments(94)
HttpMethod : PATCH                                                                                                
Json Post :
{
"FreeFieldDateTime3" : "2022-07-14T00:00:00",
"FreeFieldDateTime5" : "2005-01-25T00:00:00",
"FreeField5" : "xHu 4iqNXtXpIazp86",
"ContactId" : "41",
"FreeField4" : "YDsFZ9o",
"FreeFieldBoolean5" : "True",
"FreeFieldNumber4" : "4788696.147",
"SegmentationId" : "97",
"FreeFieldDateTime2" : "2001-03-07T00:00:00",
"SegmentTypeIdentifier" : "rmMBJt5X7T3gKhs",
"SegmentationIdentifier" : "o 55s2q2gBM",
"FreeFieldBoolean1" : "True",
"FreeField1" : "TM7MbsceCOPtlZY7U",
"SourceId" : "5",
"FreeFieldBoolean4" : "False"
}
            
Informations : 
 - Non mandatory fields are optional for Json Post

Delete a Segment
https://customerapi.fts-crm360.com/data/Segments(94)
HttpMethod : DELETE