Manage the segments linked to contacts for the current user's allowed zones.
| 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 |
Select all Segments
https://customerapi.fts-crm360.com/data/Segments()
HttpMethod : GET
Json Result :
[
{
"SegmentId" : "30",
"ContactId" : "57",
"ContactIdentifier" : "23noI2yvj9PBU5JBQ",
"SegmentationId" : "19",
"SegmentationIdentifier" : "z5LWqW7Ut",
"SegmentTypeId" : "7",
"SegmentTypeIdentifier" : "cJtfmndqoPBxp4yzum",
"PurchaseGoodId" : "92",
"PurchaseGoodIdentifier" : "Ig9w5rh8SLhEBogFUz",
"PurchaseGoodCategoryId" : "3",
"PurchaseGoodCategoryIdentifier" : "ikiDxHhb2hNsx",
"Value" : "x7L8l5FgYcs7v Ysd",
"SourceId" : "9",
"FreeField1" : "YTj959xJE",
"FreeField2" : "v90SM1",
"FreeField3" : "4XNXbBLFW YgC",
"FreeField4" : "DSYZgN9",
"FreeField5" : "9zw aod2p",
"FreeFieldDateTime1" : "2011-07-10T00:00:00",
"FreeFieldDateTime2" : "1999-09-26T00:00:00",
"FreeFieldDateTime3" : "2019-11-11T00:00:00",
"FreeFieldDateTime4" : "2019-04-26T00:00:00",
"FreeFieldDateTime5" : "1998-07-10T00:00:00",
"FreeFieldNumber1" : "7993486.246",
"FreeFieldNumber2" : "1977597.666",
"FreeFieldNumber3" : "4464656.528",
"FreeFieldNumber4" : "4349645.381",
"FreeFieldNumber5" : "7842959.847",
"FreeFieldBoolean1" : "False",
"FreeFieldBoolean2" : "False",
"FreeFieldBoolean3" : "True",
"FreeFieldBoolean4" : "True",
"FreeFieldBoolean5" : "False",
"DeletionFlag" : "True"
},
{
"SegmentId" : "34",
"ContactId" : "52",
"ContactIdentifier" : "QD hRxhuFAbayf",
"SegmentationId" : "93",
"SegmentationIdentifier" : "ebElzDZ 1ANN",
"SegmentTypeId" : "3",
"SegmentTypeIdentifier" : "6jA n",
"PurchaseGoodId" : "87",
"PurchaseGoodIdentifier" : "L9MsYTatsOIS0DlNc",
"PurchaseGoodCategoryId" : "1",
"PurchaseGoodCategoryIdentifier" : "iavUfx6g2xrSv",
"Value" : "pPFYGq",
"SourceId" : "1",
"FreeField1" : "IU EAP18zWnNT",
"FreeField2" : "aps5cyi6 6Y",
"FreeField3" : "Lzf WUf",
"FreeField4" : "SaVawqq49UqgzP brLN",
"FreeField5" : "MTCr1CBc",
"FreeFieldDateTime1" : "2024-12-03T00:00:00",
"FreeFieldDateTime2" : "1995-05-08T00:00:00",
"FreeFieldDateTime3" : "2004-03-17T00:00:00",
"FreeFieldDateTime4" : "2016-11-24T00:00:00",
"FreeFieldDateTime5" : "2004-11-09T00:00:00",
"FreeFieldNumber1" : "2133282.697",
"FreeFieldNumber2" : "3849912.222",
"FreeFieldNumber3" : "9123796.649",
"FreeFieldNumber4" : "3485282.414",
"FreeFieldNumber5" : "2436885.114",
"FreeFieldBoolean1" : "True",
"FreeFieldBoolean2" : "False",
"FreeFieldBoolean3" : "True",
"FreeFieldBoolean4" : "True",
"FreeFieldBoolean5" : "True",
"DeletionFlag" : "True"
},
...
]
Select Segment by Id
https://customerapi.fts-crm360.com/data/Segments(30)
HttpMethod : GET
Json Result :
{
"SegmentId" : "88",
"ContactId" : "5",
"ContactIdentifier" : "NJeN8X3C2zK6",
"SegmentationId" : "69",
"SegmentationIdentifier" : "rBn0ed",
"SegmentTypeId" : "9",
"SegmentTypeIdentifier" : "gjBIcKTIF6E",
"PurchaseGoodId" : "92",
"PurchaseGoodIdentifier" : "RqISQ5wnS2cJufctL",
"PurchaseGoodCategoryId" : "4",
"PurchaseGoodCategoryIdentifier" : "kzn6Lz4svtsP1",
"Value" : "SZWehNjJyNrj tq0",
"SourceId" : "4",
"FreeField1" : "gfV ov8dWMA4knmYbF",
"FreeField2" : "NoK a",
"FreeField3" : "Om KB4RytVa",
"FreeField4" : "wmgD2XH3o",
"FreeField5" : "8lRku",
"FreeFieldDateTime1" : "2001-05-07T00:00:00",
"FreeFieldDateTime2" : "2003-04-02T00:00:00",
"FreeFieldDateTime3" : "2005-11-21T00:00:00",
"FreeFieldDateTime4" : "2010-09-02T00:00:00",
"FreeFieldDateTime5" : "2022-09-27T00:00:00",
"FreeFieldNumber1" : "1354622.268",
"FreeFieldNumber2" : "9392357.636",
"FreeFieldNumber3" : "3272639.521",
"FreeFieldNumber4" : "5485351.247",
"FreeFieldNumber5" : "2138276.133",
"FreeFieldBoolean1" : "True",
"FreeFieldBoolean2" : "True",
"FreeFieldBoolean3" : "False",
"FreeFieldBoolean4" : "False",
"FreeFieldBoolean5" : "False",
"DeletionFlag" : "False"
}
Create a Segment
https://customerapi.fts-crm360.com/data/Segments()
HttpMethod : POST
Json Post :
{
"ContactId" : "47",
"ContactIdentifier" : "raQs7hQiaa",
"SegmentationId" : "89",
"SegmentationIdentifier" : "gKmaR24B8kzM7j0",
"SegmentTypeId" : "3",
"SegmentTypeIdentifier" : "5ZDue9aeDtlkQNMcz g",
"PurchaseGoodId" : "45",
"PurchaseGoodIdentifier" : "V jUu1cf 9",
"PurchaseGoodCategoryId" : "3",
"PurchaseGoodCategoryIdentifier" : "fetqALK6MJTb",
"Value" : "WluHkT1fkZf wH8",
"SourceId" : "9",
"FreeField1" : "uKUys",
"FreeField2" : "vI8UQgH0Q2Ce2w3",
"FreeField3" : "GZ96EMQQDN",
"FreeField4" : "I HH3p2 m l9bjPiso",
"FreeField5" : "OLVD6",
"FreeFieldDateTime1" : "2018-06-29T00:00:00",
"FreeFieldDateTime2" : "2014-06-28T00:00:00",
"FreeFieldDateTime3" : "2011-07-13T00:00:00",
"FreeFieldDateTime4" : "2021-09-05T00:00:00",
"FreeFieldDateTime5" : "2016-06-20T00:00:00",
"FreeFieldNumber1" : "3169427.289",
"FreeFieldNumber2" : "7982895.597",
"FreeFieldNumber3" : "6427911.218",
"FreeFieldNumber4" : "3529754.522",
"FreeFieldNumber5" : "8581536.928",
"FreeFieldBoolean1" : "False",
"FreeFieldBoolean2" : "False",
"FreeFieldBoolean3" : "True",
"FreeFieldBoolean4" : "True",
"FreeFieldBoolean5" : "True",
"DeletionFlag" : "True"
}
Informations :
- Non mandatory fields are optional for Json Post
Update a Segment
https://customerapi.fts-crm360.com/data/Segments(30)
HttpMethod : PUT
Json Post :
{
"SegmentId" : "92",
"ContactId" : "87",
"ContactIdentifier" : "XDiF7",
"SegmentationId" : "75",
"SegmentationIdentifier" : "x2ZPk Z05",
"SegmentTypeId" : "1",
"SegmentTypeIdentifier" : "PqeGCOlH28w3m",
"PurchaseGoodId" : "53",
"PurchaseGoodIdentifier" : "vBOb1WIfri2",
"PurchaseGoodCategoryId" : "3",
"PurchaseGoodCategoryIdentifier" : "tuOHN5nW2",
"Value" : "f2Wnb GfnCjozqjxpFK",
"SourceId" : "8",
"FreeField1" : "K UZHtnqs4F3D",
"FreeField2" : "keurqkBPLsE6jiaQ",
"FreeField3" : "LD U2AOUGd06",
"FreeField4" : "cvu7 R5",
"FreeField5" : "eNf6zmTLJDO",
"FreeFieldDateTime1" : "2008-05-24T00:00:00",
"FreeFieldDateTime2" : "2006-07-08T00:00:00",
"FreeFieldDateTime3" : "2022-11-15T00:00:00",
"FreeFieldDateTime4" : "2020-02-01T00:00:00",
"FreeFieldDateTime5" : "2014-12-30T00:00:00",
"FreeFieldNumber1" : "4755461.231",
"FreeFieldNumber2" : "3426624.278",
"FreeFieldNumber3" : "9414929.465",
"FreeFieldNumber4" : "7591538.419",
"FreeFieldNumber5" : "2367499.551",
"FreeFieldBoolean1" : "True",
"FreeFieldBoolean2" : "False",
"FreeFieldBoolean3" : "True",
"FreeFieldBoolean4" : "True",
"FreeFieldBoolean5" : "True",
"DeletionFlag" : "False"
}
Informations :
- Non mandatory fields are optional for Json Post
Patch a Segment
https://customerapi.fts-crm360.com/data/Segments(30)
HttpMethod : PATCH
Json Post :
{
"FreeFieldDateTime2" : "2014-07-19T00:00:00",
"FreeFieldBoolean1" : "False",
"FreeFieldBoolean3" : "False",
"FreeFieldBoolean2" : "True",
"FreeFieldDateTime3" : "2013-06-19T00:00:00",
"FreeFieldDateTime4" : "2016-06-04T00:00:00"
}
Informations :
- Non mandatory fields are optional for Json Post
Delete a Segment
https://customerapi.fts-crm360.com/data/Segments(30)
HttpMethod : DELETE