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" : "16", "ContactId" : "34", "Address1" : "jqT73AbQVpmpHYdn", "Address2" : "h1vaTBpFDTwZtiMW1", "Address3" : "vbegsY0y21 KP", "Address4" : "1NmdCHXQS", "Address5" : "7Ie66Dbxh538VAIX", "Address6" : "fJyr4Cdhf6uSt", "Address7" : "dJsjj352", "PostCode" : "nnVZ42lUrh2GfFCE", "City" : "YaHsd", "State" : "sZyobkdqoVXCQtDon", "CountryId" : "ZmLVXpmge", "AddressOptin" : "False", "AddressAdvertiserCreationDate" : "2010-12-10T00:00:00", "AddressStateId" : "44", "Email" : "tIzn FOJvM1OwIB", "EmailOptin" : "False", "EmailAdvertiserCreationDate" : "2006-01-19T00:00:00", "EmailStateId" : "95", "HomePhoneNumber" : "yyS1nXAIA5FmJMpp", "HomePhoneCountryId" : "bEDhZKpZUGmgkvH4wo", "HomePhoneOptin" : "False", "HomePhoneAdvertiserCreationDate" : "2007-08-06T00:00:00", "HomePhoneStateId" : "29", "MobilePhoneNumber" : "P98MOol", "MobilePhoneCountryId" : "AFdHUQ3NZmocTQ", "MobilePhoneOptin" : "False", "MobilePhoneAdvertiserCreationDate" : "2008-08-22T00:00:00", "MobilePhoneStateId" : "18", "DeletionFlag" : "False", "BrandId" : "70", "ContactAddressTypeId" : "4", "BrandIdString" : "wOnQ EjL7AznE" }, { "AddressId" : "52", "ContactId" : "4", "Address1" : "1AiPRw 2 j", "Address2" : "wCq3TdUPfC", "Address3" : "zoMqnoqL4k", "Address4" : "Hr0TecyZ0gOa3V6U", "Address5" : "Ly7X N4BlILMzq", "Address6" : "wSiLcJ0xtplR wyR", "Address7" : "WjsyBYsd7R3UlLB", "PostCode" : "epkyu1bW Osz6dQz1", "City" : "1O87u40tg37b", "State" : "cjb6GM", "CountryId" : "9eGWxyr4ic E", "AddressOptin" : "False", "AddressAdvertiserCreationDate" : "1998-04-23T00:00:00", "AddressStateId" : "35", "Email" : "3h6q8 UjZjGPPeiJl", "EmailOptin" : "False", "EmailAdvertiserCreationDate" : "2010-08-20T00:00:00", "EmailStateId" : "35", "HomePhoneNumber" : "lJ6N6K", "HomePhoneCountryId" : "21 Gv", "HomePhoneOptin" : "False", "HomePhoneAdvertiserCreationDate" : "2006-09-19T00:00:00", "HomePhoneStateId" : "18", "MobilePhoneNumber" : "g8Ki7NqboD41e", "MobilePhoneCountryId" : "l rRY", "MobilePhoneOptin" : "True", "MobilePhoneAdvertiserCreationDate" : "1995-11-15T00:00:00", "MobilePhoneStateId" : "84", "DeletionFlag" : "True", "BrandId" : "70", "ContactAddressTypeId" : "5", "BrandIdString" : "GHe6K9C2iKjo6" }, ... ]

Select Address by Id

https://customerapi.fts-crm360.com/data/Addresses(16)
HttpMethod : GET
Json Result :
{ "AddressId" : "27", "ContactId" : "78", "Address1" : "GKAX4 HCR", "Address2" : "LEeG50ZojTIHt2aNBzH", "Address3" : "btquuEqKqr apK", "Address4" : "9XaQtOSscI9bJ7rX", "Address5" : "6oic vY0J", "Address6" : "92TsdiDb", "Address7" : "mi YJAMkvngO9Urf", "PostCode" : "VjnB i T Iaf4E", "City" : "0vwgPYaMJoMo", "State" : "hnMc6u3NjH1Y0LCJPu", "CountryId" : "vIj5 wO4WcZ", "AddressOptin" : "False", "AddressAdvertiserCreationDate" : "2022-12-11T00:00:00", "AddressStateId" : "3", "Email" : "SgOB9WlnK", "EmailOptin" : "True", "EmailAdvertiserCreationDate" : "2015-02-04T00:00:00", "EmailStateId" : "87", "HomePhoneNumber" : "OI ZdMO19sMsr", "HomePhoneCountryId" : "hwK67Wf4h5MwEJfYS", "HomePhoneOptin" : "True", "HomePhoneAdvertiserCreationDate" : "2022-02-17T00:00:00", "HomePhoneStateId" : "68", "MobilePhoneNumber" : "Mb utxdTzAURgD", "MobilePhoneCountryId" : "stgBVmFLsGEVkZ2", "MobilePhoneOptin" : "True", "MobilePhoneAdvertiserCreationDate" : "2005-01-05T00:00:00", "MobilePhoneStateId" : "31", "DeletionFlag" : "True", "BrandId" : "19", "ContactAddressTypeId" : "3", "BrandIdString" : "Bkt43ejFoYlmX" }

Create a Address

https://customerapi.fts-crm360.com/data/Addresses()
HttpMethod : POST
Json Post :
{
"ContactId" : "65",
"Address1" : "kWzBlsIuZ",
"Address2" : "fRWuj g",
"Address3" : "7 v4MSNh9rMz",
"Address4" : "bW0u7XIn",
"Address5" : "31TvYNNXEjEH okrJ",
"Address6" : "Dtbhl4C5g m",
"Address7" : "X2EG4kb5 Um",
"PostCode" : "nuHAsPBx1UiHbT",
"City" : "1USrXdGsQVhrGsl",
"State" : "uG042wAMQ7 kBT7qk",
"CountryId" : "lksnPHfA1rJj6DQfzA",
"AddressOptin" : "False",
"AddressAdvertiserCreationDate" : "2007-08-18T00:00:00",
"AddressStateId" : "85",
"Email" : "SE  og",
"EmailOptin" : "False",
"EmailAdvertiserCreationDate" : "2024-04-09T00:00:00",
"EmailStateId" : "38",
"HomePhoneNumber" : "GPGAGG1sY05VBsAvUh",
"HomePhoneCountryId" : "6DJAgRmM e9W",
"HomePhoneOptin" : "False",
"HomePhoneAdvertiserCreationDate" : "2004-05-04T00:00:00",
"HomePhoneStateId" : "29",
"MobilePhoneNumber" : "r8PZsK3A J8",
"MobilePhoneCountryId" : "tZ3MH",
"MobilePhoneOptin" : "False",
"MobilePhoneAdvertiserCreationDate" : "2008-12-30T00:00:00",
"MobilePhoneStateId" : "80",
"DeletionFlag" : "True",
"BrandId" : "23",
"ContactAddressTypeId" : "6",
"BrandIdString" : "e4ANZdABvPUyEHxv"
}
            
Informations :
- Non mandatory fields are optional for Json Post

Update a Address

https://customerapi.fts-crm360.com/data/Addresses(16)
HttpMethod : PUT
Json Post :
{
"AddressId" : "20",
"ContactId" : "14",
"Address1" : "WUkea",
"Address2" : "xOa0efcYf5zIpm",
"Address3" : "I6ScDFH rsmz",
"Address4" : "N 5ZllnP",
"Address5" : "LQv2ZjN8lggdM",
"Address6" : "RBWfpOvI3r",
"Address7" : "JE  iD R",
"PostCode" : "uAsMrixtFERu",
"City" : "nWOF8",
"State" : "0CXCn",
"CountryId" : "eNiCcgMo",
"AddressOptin" : "False",
"AddressAdvertiserCreationDate" : "2002-12-01T00:00:00",
"AddressStateId" : "33",
"Email" : "GbABzZ",
"EmailOptin" : "True",
"EmailAdvertiserCreationDate" : "1999-06-12T00:00:00",
"EmailStateId" : "7",
"HomePhoneNumber" : "CU8APtrook",
"HomePhoneCountryId" : "DjKCmwhXXXB",
"HomePhoneOptin" : "True",
"HomePhoneAdvertiserCreationDate" : "2003-03-22T00:00:00",
"HomePhoneStateId" : "85",
"MobilePhoneNumber" : "z jpHF 0etef8",
"MobilePhoneCountryId" : "8mqkXC31 Lo9xr APs",
"MobilePhoneOptin" : "True",
"MobilePhoneAdvertiserCreationDate" : "2015-09-04T00:00:00",
"MobilePhoneStateId" : "92",
"DeletionFlag" : "False",
"BrandId" : "8",
"ContactAddressTypeId" : "9",
"BrandIdString" : "VouqUGPjb v"
}
            
Informations :
- Non mandatory fields are optional for Json Post

Patch a Address

https://customerapi.fts-crm360.com/data/Addresses(16)
HttpMethod : PATCH
Json Post :
{
"CountryId" : "e3zr7AY JU",
"MobilePhoneOptin" : "False",
"EmailStateId" : "82",
"HomePhoneAdvertiserCreationDate" : "2009-07-03T00:00:00"
}
            
Informations :
- Non mandatory fields are optional for Json Post

Delete a Address

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