CRM360° CustomerApi Documentation
Return to Odata Help Page

Customer - Contact

Manage contact entities excepting addresses (Cf Address entity)

Required HTTP Headers

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

Functions

Entity Properties

Name Type Is Mandatory
ContactId Int32
GenderId Int16
CivilityId Int16
TitleId Int16
FirstName String
MiddleName String
LastName String
LastName2 String
FirstNameSecondAlphabet String
MiddleNameSecondAlphabet String
LastNameSecondAlphabet String
LastName2SecondAlphabet String
BirthDate DateTime
BirthDay Int16
BirthMonth Int16
BirthYear Int16
MaritalStatusId Int16
JobTitle String
CompanyName String
GlobalOptin Boolean
GlobalPartnerOptin Boolean
ContactStateId Int16
ContactTypeId Int16
AdvertiserCreationDate DateTime
NationalityId Int16
LanguageId String
DeletionFlag Boolean
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
ZoneId Int32
ZoneIdString String
Civility Civility
Zone Zone
PurchaseHeaders Collection of PurchaseHeader
Gender Gender
Title Title
MaritalStatus MaritalStatus
ContactState ContactState
Nationality Nationality
Language Language
ContactType ContactType
ContactIdentifiers Collection of ContactIdentifier
MarketingParticipants Collection of MarketingParticipant
LoyaltyCards Collection of LoyaltyCard
LoyaltyPoints Collection of LoyaltyPoint
AttachedStores Collection of AttachedStore
ContactDescendantLinks Collection of ContactLink
ContactAscendantLinks Collection of ContactLink
Cases Collection of Case
Vouchers Collection of Voucher
Segments Collection of Segment
Addresses Collection of Address
ContactInterests Collection of ContactInterest

Actions

Action Name Method Parameters Description Return
SumPurchaseHeader POST
  • column (String)
  • year (Int32)
  • brandId (Int32)
 Compute Sum of chosen column of related PurchaseHeader entities Decimal 
Example
https://customerapi.fts-crm360.com/data/Contacts(32)/SumPurchaseHeader?column=Amount&year=2014&brandId=1


HttpMethod : POST
                                                                                       

Informations : 
           - column = Amount | TaxFreeAmount | DiscountAmount | RefAmount | RefTaxFreeAmount | RefDiscountAmount
            - brandId is optional
            - year is optional
SumPurchaseDetail POST
  • column (String)
  • year (Int32)
  • brandId (Int32)
 Compute Sum of chosen column of related PurchaseDetail entities Decimal 
Example
https://customerapi.fts-crm360.com/data/Contacts(32)/SumPurchaseDetail?column=Amount&year=2014&brandId=1


HttpMethod : POST
                                                                                       

Informations : 
           - column = Amount | TaxFreeAmount | DiscountAmount | RefAmount | RefTaxFreeAmount | RefDiscountAmount | Quantity
            - brandId is optional
            - year is optional
SumLoyaltyPoint POST
  • column (String)
  • loyaltyPointTypeId (Int32)
  • loyaltyCardTypeId (Int32)
  • brandId (Int32)
  • firstContactId (Int32)
  • secondContactId (Int32)
  • consolidationRuleId (Int32)
  • contactList (String)
  • consolidationRuleId (Int32)
 Compute Sum of chosen column of related LoyaltyPoint entities Decimal 
Example
https://customerapi.fts-crm360.com/data/Contacts(32)/SumLoyaltyPoint?column=Amount&loyaltyPointTypeId=1&loyaltyCardTypeId=2&brandId=1


HttpMethod : POST
                                                                                       

Informations : 
           - column = PointAmount | PointOriginalAmount | PointUsedAmount | PointExpiredAmount
            - loyaltyPointTypeId is optional
            - loyaltyCardTypeId is optional
            - brandId is optional

Examples

Select all Contacts
https://customerapi.fts-crm360.com/data/Contacts()


HttpMethod : GET
                                                                                       

Json Result : 

[
{
"ContactId" : "40",
"GenderId" : "2",
"CivilityId" : "2",
"TitleId" : "4",
"FirstName" : "k8mM3",
"MiddleName" : "M  Kwc24Fw",
"LastName" : "XyVFPiQrbM",
"LastName2" : "lia29UF74qyi8M772",
"FirstNameSecondAlphabet" : "9n BzYC",
"MiddleNameSecondAlphabet" : "U WgbLZYQv3dhyI1rj",
"LastNameSecondAlphabet" : "Y4SlYaaO",
"LastName2SecondAlphabet" : "Kgme6 w",
"BirthDate" : "2011-02-16T00:00:00",
"BirthDay" : "5",
"BirthMonth" : "2",
"BirthYear" : "4",
"MaritalStatusId" : "4",
"JobTitle" : "zrL9xcKejVOHq",
"CompanyName" : "B 8EA",
"GlobalOptin" : "False",
"GlobalPartnerOptin" : "True",
"ContactStateId" : "2",
"ContactTypeId" : "7",
"AdvertiserCreationDate" : "1999-05-23T00:00:00",
"NationalityId" : "4",
"LanguageId" : "GAmUhN3 EmZ o",
"DeletionFlag" : "False",
"FreeField1" : "rmLXX",
"FreeField2" : "usjDVZU",
"FreeField3" : "8ClOVJ2Oz P06",
"FreeField4" : "ibC4hkiwASs",
"FreeField5" : "5vc3dfcpV",
"FreeFieldDateTime1" : "2019-12-08T00:00:00",
"FreeFieldDateTime2" : "2007-08-13T00:00:00",
"FreeFieldDateTime3" : "2013-12-30T00:00:00",
"FreeFieldDateTime4" : "2022-06-11T00:00:00",
"FreeFieldDateTime5" : "2020-02-13T00:00:00",
"FreeFieldNumber1" : "4442453.316",
"FreeFieldNumber2" : "3581436.968",
"FreeFieldNumber3" : "9542745.717",
"FreeFieldNumber4" : "1417224.983",
"FreeFieldNumber5" : "9678697.431",
"FreeFieldBoolean1" : "True",
"FreeFieldBoolean2" : "False",
"FreeFieldBoolean3" : "False",
"FreeFieldBoolean4" : "False",
"FreeFieldBoolean5" : "True",
"ZoneId" : "88",
"ZoneIdString" : "OWDAi"
},
{
"ContactId" : "21",
"GenderId" : "3",
"CivilityId" : "6",
"TitleId" : "8",
"FirstName" : "CzN3qDZ4Twfh",
"MiddleName" : "mAf ejb80UJJizM",
"LastName" : "bOudpnAKjZk",
"LastName2" : "iHfsib",
"FirstNameSecondAlphabet" : "LxB h",
"MiddleNameSecondAlphabet" : "eDtHPLd4",
"LastNameSecondAlphabet" : "RyU8Ye06J",
"LastName2SecondAlphabet" : "SMpc XNXNpMT7cI7",
"BirthDate" : "2008-10-16T00:00:00",
"BirthDay" : "4",
"BirthMonth" : "2",
"BirthYear" : "4",
"MaritalStatusId" : "6",
"JobTitle" : "zN4OemiW12is5R",
"CompanyName" : "QI39GqoEeYe",
"GlobalOptin" : "False",
"GlobalPartnerOptin" : "True",
"ContactStateId" : "4",
"ContactTypeId" : "5",
"AdvertiserCreationDate" : "1995-06-24T00:00:00",
"NationalityId" : "5",
"LanguageId" : "nYajw3m",
"DeletionFlag" : "False",
"FreeField1" : "zUvOh1hLSQZh KIZ0",
"FreeField2" : "A8X1DgR4 r",
"FreeField3" : "XSy0vuI8Y",
"FreeField4" : "LLvEnoNRJ53Py4bcrsQ",
"FreeField5" : "if6QBOLUZqsB9AwKG94",
"FreeFieldDateTime1" : "2014-05-23T00:00:00",
"FreeFieldDateTime2" : "2016-01-30T00:00:00",
"FreeFieldDateTime3" : "2016-09-22T00:00:00",
"FreeFieldDateTime4" : "2011-03-14T00:00:00",
"FreeFieldDateTime5" : "2009-02-21T00:00:00",
"FreeFieldNumber1" : "1259431.474",
"FreeFieldNumber2" : "5735145.885",
"FreeFieldNumber3" : "2838234.786",
"FreeFieldNumber4" : "3895297.392",
"FreeFieldNumber5" : "6345619.695",
"FreeFieldBoolean1" : "False",
"FreeFieldBoolean2" : "False",
"FreeFieldBoolean3" : "False",
"FreeFieldBoolean4" : "True",
"FreeFieldBoolean5" : "True",
"ZoneId" : "26",
"ZoneIdString" : "tvI5WnDJmtyVIoJ7w"
},
...
]
            
                                                     

Select Contact by Id
https://customerapi.fts-crm360.com/data/Contacts(40)


HttpMethod : GET
                                                                                       

Json Result : 

{
"ContactId" : "87",
"GenderId" : "9",
"CivilityId" : "5",
"TitleId" : "7",
"FirstName" : "CVvwSbc",
"MiddleName" : "N4CAhyLQnQY8WHRx1A1",
"LastName" : "JSuIf",
"LastName2" : "yKkUnslxkaEnmIk",
"FirstNameSecondAlphabet" : "UPUPsNc9bal7x6",
"MiddleNameSecondAlphabet" : "5f0  qS",
"LastNameSecondAlphabet" : "qXjh0rNZtei8ez",
"LastName2SecondAlphabet" : "ktl3LGp",
"BirthDate" : "2015-01-31T00:00:00",
"BirthDay" : "3",
"BirthMonth" : "2",
"BirthYear" : "2",
"MaritalStatusId" : "8",
"JobTitle" : "j6Alp2H",
"CompanyName" : "mRNA2cO8qGO0 SE",
"GlobalOptin" : "True",
"GlobalPartnerOptin" : "True",
"ContactStateId" : "6",
"ContactTypeId" : "7",
"AdvertiserCreationDate" : "2011-12-31T00:00:00",
"NationalityId" : "8",
"LanguageId" : "gFmj5m63IY25F",
"DeletionFlag" : "False",
"FreeField1" : "JPLxrmC36uQ1mJ",
"FreeField2" : "KjyCwG",
"FreeField3" : "ThmBx909fMw",
"FreeField4" : "RTfwL7dNq0owUuBN",
"FreeField5" : "GBihv7pKp",
"FreeFieldDateTime1" : "2020-04-22T00:00:00",
"FreeFieldDateTime2" : "1997-08-08T00:00:00",
"FreeFieldDateTime3" : "1996-02-12T00:00:00",
"FreeFieldDateTime4" : "2024-06-11T00:00:00",
"FreeFieldDateTime5" : "2001-10-14T00:00:00",
"FreeFieldNumber1" : "1188868.613",
"FreeFieldNumber2" : "9758871.967",
"FreeFieldNumber3" : "4222548.652",
"FreeFieldNumber4" : "4276675.836",
"FreeFieldNumber5" : "5593615.739",
"FreeFieldBoolean1" : "True",
"FreeFieldBoolean2" : "False",
"FreeFieldBoolean3" : "False",
"FreeFieldBoolean4" : "True",
"FreeFieldBoolean5" : "False",
"ZoneId" : "91",
"ZoneIdString" : "oV yME94tA0TKOKqC"
}
            
                                                     

Create a Contact
https://customerapi.fts-crm360.com/data/Contacts()


HttpMethod : POST
                                                                                                

Json Post :
{
"GenderId" : "2",
"CivilityId" : "8",
"TitleId" : "3",
"FirstName" : "jf3ERjVOwaxpz h xRb",
"MiddleName" : "W6 ocItldWE8r4E gs5",
"LastName" : "oq7kCoW o0R5",
"LastName2" : "QlnfPmI1uv",
"FirstNameSecondAlphabet" : "95vtSDW6T",
"MiddleNameSecondAlphabet" : "k xS8nEJg TbT",
"LastNameSecondAlphabet" : "Fxo45hOOq",
"LastName2SecondAlphabet" : "q6hMif84oFq",
"BirthDate" : "2019-05-03T00:00:00",
"BirthDay" : "4",
"BirthMonth" : "5",
"BirthYear" : "7",
"MaritalStatusId" : "2",
"JobTitle" : "LSilSZA9j",
"CompanyName" : "ZwbLWJVnB",
"GlobalOptin" : "False",
"GlobalPartnerOptin" : "True",
"ContactStateId" : "6",
"ContactTypeId" : "1",
"AdvertiserCreationDate" : "2008-11-30T00:00:00",
"NationalityId" : "4",
"LanguageId" : "NlSaFIzMB6G0XggO",
"DeletionFlag" : "True",
"FreeField1" : "IL5To 6uBckRF",
"FreeField2" : "eLaqHLQ",
"FreeField3" : "OIaBePgjnmz3QmTRoaK",
"FreeField4" : "xvcoAp3UEi1",
"FreeField5" : "SK7w3",
"FreeFieldDateTime1" : "2013-07-11T00:00:00",
"FreeFieldDateTime2" : "2010-10-12T00:00:00",
"FreeFieldDateTime3" : "2015-06-18T00:00:00",
"FreeFieldDateTime4" : "2001-07-16T00:00:00",
"FreeFieldDateTime5" : "2009-01-14T00:00:00",
"FreeFieldNumber1" : "8952988.217",
"FreeFieldNumber2" : "1825771.842",
"FreeFieldNumber3" : "5178616.541",
"FreeFieldNumber4" : "9523952.871",
"FreeFieldNumber5" : "4952149.512",
"FreeFieldBoolean1" : "False",
"FreeFieldBoolean2" : "False",
"FreeFieldBoolean3" : "False",
"FreeFieldBoolean4" : "True",
"FreeFieldBoolean5" : "True",
"ZoneId" : "75",
"ZoneIdString" : "rm1NVv9y"
}
            


Informations : 
 - Non mandatory fields are optional for Json Post
                                                     

Update a Contact
https://customerapi.fts-crm360.com/data/Contacts(40)


HttpMethod : PUT
                                                                                                

Json Post :
{
"ContactId" : "52",
"GenderId" : "7",
"CivilityId" : "8",
"TitleId" : "5",
"FirstName" : "lMGXvihl",
"MiddleName" : "JFLcRcOMJVLQeM2x",
"LastName" : "LiWewG",
"LastName2" : "2gYi6RaMm5bvA3dgiT",
"FirstNameSecondAlphabet" : "hX7F PkoX PR",
"MiddleNameSecondAlphabet" : "9RlwEqQ359",
"LastNameSecondAlphabet" : "kwGwNsAyKQkh5a",
"LastName2SecondAlphabet" : "TWoDMXnCxu",
"BirthDate" : "2003-09-16T00:00:00",
"BirthDay" : "7",
"BirthMonth" : "5",
"BirthYear" : "8",
"MaritalStatusId" : "1",
"JobTitle" : "nYSfPHzap9bGHZ",
"CompanyName" : "qVrX4P1wR8sVA6 j",
"GlobalOptin" : "True",
"GlobalPartnerOptin" : "False",
"ContactStateId" : "6",
"ContactTypeId" : "9",
"AdvertiserCreationDate" : "1999-07-12T00:00:00",
"NationalityId" : "6",
"LanguageId" : "IKhMZO6g6Y mXvgIYw",
"DeletionFlag" : "True",
"FreeField1" : "ihyye",
"FreeField2" : "Zg ealC iLWBbh",
"FreeField3" : "aw7AUnzZ9Q",
"FreeField4" : "glXlXvs",
"FreeField5" : "Zhb7Zi7LUxVUEqH",
"FreeFieldDateTime1" : "2018-07-22T00:00:00",
"FreeFieldDateTime2" : "2020-12-25T00:00:00",
"FreeFieldDateTime3" : "2018-04-09T00:00:00",
"FreeFieldDateTime4" : "2000-06-16T00:00:00",
"FreeFieldDateTime5" : "1996-01-18T00:00:00",
"FreeFieldNumber1" : "6213315.198",
"FreeFieldNumber2" : "6377993.167",
"FreeFieldNumber3" : "7612984.938",
"FreeFieldNumber4" : "5957335.273",
"FreeFieldNumber5" : "1935216.473",
"FreeFieldBoolean1" : "False",
"FreeFieldBoolean2" : "True",
"FreeFieldBoolean3" : "True",
"FreeFieldBoolean4" : "False",
"FreeFieldBoolean5" : "False",
"ZoneId" : "96",
"ZoneIdString" : "0TXnh"
}
            


Informations : 
 - Non mandatory fields are optional for Json Post
                                                     

Patch a Contact
https://customerapi.fts-crm360.com/data/Contacts(40)


HttpMethod : PATCH
                                                                                                

Json Post :
{
"LastNameSecondAlphabet" : "ISmy9cqXGSTqwYj 4",
"MiddleNameSecondAlphabet" : "CK Yq1GW",
"GlobalPartnerOptin" : "False",
"GenderId" : "2",
"FreeField4" : "4UriEENiNo6D1Ui",
"ZoneId" : "81",
"FreeField5" : "ljd  HkXywmwqnKb",
"BirthDate" : "2016-01-04T00:00:00",
"FreeFieldBoolean2" : "True",
"ContactStateId" : "9"
}
            


Informations : 
 - Non mandatory fields are optional for Json Post
                                                     

Delete a Contact
https://customerapi.fts-crm360.com/data/Contacts(40)


HttpMethod : DELETE