CRM360° CustomerApi Documentation

Customer - Address

Manage contact's address entities. An address entity is composed of postal address, email, mobile email, home phone and mobile phone.

Required HTTP Headers

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

Functions

Entity Properties

Name Type Is Mandatory
AddressId Int32
ContactId Int32
Address1 String
Address2 String
Address3 String
Address4 String
Address5 String
Address6 String
Address7 String
PostCode String
City String
State String
CountryId String
AddressOptin Boolean
AddressAdvertiserCreationDate DateTime
AddressStateId Int32
Email String
EmailOptin Boolean
EmailAdvertiserCreationDate DateTime
EmailStateId Int32
HomePhoneNumber String
HomePhoneCountryId String
HomePhoneOptin Boolean
HomePhoneAdvertiserCreationDate DateTime
HomePhoneStateId Int32
MobilePhoneNumber String
MobilePhoneCountryId String
MobilePhoneOptin Boolean
MobilePhoneAdvertiserCreationDate DateTime
MobilePhoneStateId Int32
DeletionFlag Boolean
BrandId Int32
ContactAddressTypeId Int16
BrandIdString String
Brand Brand
ContactAddressType ContactAddressType
EmailState EmailState
HomePhoneState HomePhoneState
MobilePhoneState MobilePhoneState
PostalAddressState PostalAddressState
Contact Contact
PostalAddresseCountry Country
HomePhoneCountry Country
MobilePhoneCountry Country

Examples

Select all Addresses

https://customerapi.fts-crm360.com/data/Addresses()
HttpMethod : GET
Json Result :
[ { "AddressId" : "29", "ContactId" : "83", "Address1" : "aen4GVWPyJ", "Address2" : "iHK XXxJCWxzSUl", "Address3" : "yxrgGxLB", "Address4" : "0R6DI 7w7KI", "Address5" : "UMQHx orVkgF", "Address6" : "dGolw6IigF1E4", "Address7" : "0BVJboXbdP", "PostCode" : "MYvesZ9jg HVZMb1zG", "City" : "B2nzp aDbMA", "State" : "YnwuvzAYbFV0 5", "CountryId" : "vPLfo", "AddressOptin" : "False", "AddressAdvertiserCreationDate" : "2019-09-13T00:00:00", "AddressStateId" : "93", "Email" : "jkFeQV", "EmailOptin" : "True", "EmailAdvertiserCreationDate" : "2005-08-20T00:00:00", "EmailStateId" : "49", "HomePhoneNumber" : "utndsCxt", "HomePhoneCountryId" : "7hyyv q QrYQiroJKtg", "HomePhoneOptin" : "True", "HomePhoneAdvertiserCreationDate" : "1998-04-08T00:00:00", "HomePhoneStateId" : "57", "MobilePhoneNumber" : "VzKRGxec1o3 lxxVelg", "MobilePhoneCountryId" : "qF6LB TgV", "MobilePhoneOptin" : "True", "MobilePhoneAdvertiserCreationDate" : "2012-08-31T00:00:00", "MobilePhoneStateId" : "84", "DeletionFlag" : "False", "BrandId" : "55", "ContactAddressTypeId" : "5", "BrandIdString" : "jtiBwOgmprBXZXBglTT" }, { "AddressId" : "24", "ContactId" : "87", "Address1" : "PHc9GmBBnBVxxxBdeak", "Address2" : "gW76G8NEP", "Address3" : "PMHjc", "Address4" : "kyH5knC Bml", "Address5" : "dGz2pid4", "Address6" : "g1IY8xj", "Address7" : "HpMUl3rTpv4S84fX", "PostCode" : "lIPXhjFjQD79gm0dM57", "City" : "63OGj zjlN", "State" : "VxaWoUakEFvV v", "CountryId" : "IHCzv9j Bt", "AddressOptin" : "True", "AddressAdvertiserCreationDate" : "1998-12-08T00:00:00", "AddressStateId" : "81", "Email" : "wg9CblMFQMJxV", "EmailOptin" : "False", "EmailAdvertiserCreationDate" : "2003-03-30T00:00:00", "EmailStateId" : "18", "HomePhoneNumber" : "ZXN1qfxcoxyYo", "HomePhoneCountryId" : "LmBTkxRXIIB21p9", "HomePhoneOptin" : "False", "HomePhoneAdvertiserCreationDate" : "2015-07-25T00:00:00", "HomePhoneStateId" : "70", "MobilePhoneNumber" : "KfwkrFALly tnc9J", "MobilePhoneCountryId" : "hsZPANE z", "MobilePhoneOptin" : "False", "MobilePhoneAdvertiserCreationDate" : "1998-08-18T00:00:00", "MobilePhoneStateId" : "48", "DeletionFlag" : "True", "BrandId" : "8", "ContactAddressTypeId" : "1", "BrandIdString" : "cO AWNikrkUt" }, ... ]

Select Address by Id

https://customerapi.fts-crm360.com/data/Addresses(29)
HttpMethod : GET
Json Result :
{ "AddressId" : "33", "ContactId" : "25", "Address1" : "qzVJ c6die", "Address2" : "RXDGyvULJOiH7UIzj", "Address3" : "4WejPbpp5ED", "Address4" : "w2he6LgkyjZI", "Address5" : "JHrZ01", "Address6" : "WAoIXtGnbH OHn", "Address7" : "rlbY7S pU8We", "PostCode" : "U9PDO", "City" : "uNYGNE4", "State" : "puJ br", "CountryId" : "E7c4WXXTKAN", "AddressOptin" : "False", "AddressAdvertiserCreationDate" : "2003-11-27T00:00:00", "AddressStateId" : "47", "Email" : "v tcvcMVJ2Y1 kyVB", "EmailOptin" : "False", "EmailAdvertiserCreationDate" : "2021-04-11T00:00:00", "EmailStateId" : "31", "HomePhoneNumber" : "VCyW5NF Clpx J", "HomePhoneCountryId" : "692mSA9g", "HomePhoneOptin" : "True", "HomePhoneAdvertiserCreationDate" : "2016-04-16T00:00:00", "HomePhoneStateId" : "38", "MobilePhoneNumber" : "Lm jjIqqqYi OJz", "MobilePhoneCountryId" : "MNloBCd4ArUTDR9L", "MobilePhoneOptin" : "True", "MobilePhoneAdvertiserCreationDate" : "2007-04-21T00:00:00", "MobilePhoneStateId" : "81", "DeletionFlag" : "True", "BrandId" : "17", "ContactAddressTypeId" : "1", "BrandIdString" : "1dnUia2Y" }

Create a Address

https://customerapi.fts-crm360.com/data/Addresses()
HttpMethod : POST
Json Post :
{
"ContactId" : "15",
"Address1" : "KTKHuoIH",
"Address2" : "h3 WlY WJzVX",
"Address3" : "H vJZt6cJTKF48",
"Address4" : "CFxqTohUBGB6HDtjy",
"Address5" : "hLJXjO MCYjoQramT",
"Address6" : "BqC9k",
"Address7" : "tBXyyZauYQWwoqg",
"PostCode" : "QGkIwY1Vegwph",
"City" : "yjmeph",
"State" : "m p8 Q Vq9nhe 7Za5",
"CountryId" : "KASRnxMPc",
"AddressOptin" : "True",
"AddressAdvertiserCreationDate" : "1999-07-05T00:00:00",
"AddressStateId" : "15",
"Email" : "qor6",
"EmailOptin" : "False",
"EmailAdvertiserCreationDate" : "2022-04-08T00:00:00",
"EmailStateId" : "13",
"HomePhoneNumber" : "hHHCt0JKjUW1UHA",
"HomePhoneCountryId" : "n ghf m",
"HomePhoneOptin" : "True",
"HomePhoneAdvertiserCreationDate" : "2018-11-29T00:00:00",
"HomePhoneStateId" : "77",
"MobilePhoneNumber" : "dP9MT du",
"MobilePhoneCountryId" : "oJhnn9jrn Uj",
"MobilePhoneOptin" : "True",
"MobilePhoneAdvertiserCreationDate" : "1995-04-23T00:00:00",
"MobilePhoneStateId" : "31",
"DeletionFlag" : "False",
"BrandId" : "33",
"ContactAddressTypeId" : "5",
"BrandIdString" : "tgkO7lr6l"
}
            
Informations :
- Non mandatory fields are optional for Json Post

Update a Address

https://customerapi.fts-crm360.com/data/Addresses(29)
HttpMethod : PUT
Json Post :
{
"AddressId" : "12",
"ContactId" : "4",
"Address1" : "0Zggdc44hP54 brjO",
"Address2" : "E9hJA D6lA6C9jl",
"Address3" : "dJXd0oajxclqOe4Hs5A",
"Address4" : "TrXhc",
"Address5" : "239eQVT 9gMv0",
"Address6" : "i8YiYYrFGzW",
"Address7" : "hhqxy",
"PostCode" : "ASwhlRMPWNgY57Eke",
"City" : "S JD1xwJIM",
"State" : "xVLuXuhqAXFWHBdj",
"CountryId" : "3Z98BUe9q7b xaI",
"AddressOptin" : "True",
"AddressAdvertiserCreationDate" : "2012-01-21T00:00:00",
"AddressStateId" : "87",
"Email" : "oiMh5d9Lc",
"EmailOptin" : "True",
"EmailAdvertiserCreationDate" : "1996-03-04T00:00:00",
"EmailStateId" : "38",
"HomePhoneNumber" : "AQuN0uAs",
"HomePhoneCountryId" : "ryFqO68WqblOEVMb",
"HomePhoneOptin" : "True",
"HomePhoneAdvertiserCreationDate" : "2011-06-18T00:00:00",
"HomePhoneStateId" : "35",
"MobilePhoneNumber" : "fp4DxwK x",
"MobilePhoneCountryId" : "11n32 aOPBOGVl",
"MobilePhoneOptin" : "False",
"MobilePhoneAdvertiserCreationDate" : "2023-03-19T00:00:00",
"MobilePhoneStateId" : "93",
"DeletionFlag" : "False",
"BrandId" : "54",
"ContactAddressTypeId" : "7",
"BrandIdString" : "KqZQA3B4dwhjClvmM"
}
            
Informations :
- Non mandatory fields are optional for Json Post

Patch a Address

https://customerapi.fts-crm360.com/data/Addresses(29)
HttpMethod : PATCH
Json Post :
{
"MobilePhoneAdvertiserCreationDate" : "2008-06-02T00:00:00",
"CountryId" : "yTTCYTTRz O2Azq",
"AddressStateId" : "18",
"EmailOptin" : "True",
"HomePhoneOptin" : "False"
}
            
Informations :
- Non mandatory fields are optional for Json Post

Delete a Address

https://customerapi.fts-crm360.com/data/Addresses(29)
HttpMethod : DELETE