Use this request to edit an existing address. This address can belong to an individual or organization account.
REST
Request
https://api.neoncrm.com/neonws/services/api/account/updateAddress?responseType=xml&userSessionId=T1356662249816&accountId=3489&Address.addressId=3330&Address.isPrimaryAddress=true&Address.shippingAddress=true&Address.addressType.id=2&Address.addressType.name=Home&Address.addressLine1=xxx&Address.addressLine2=yyy&Address.addressLine3=ccc&Address.addressLine4=ddd&Address.city=chengdu&Address.state.code=AL&Address.state.name=ALABAMA&Address.province=sichuan&Address.county=county&Address.country.id=1&Address.country.name=United%20States&Address.zipCode=39111&Address.zipCodeSuffix=1355&Address.startDate=1990-03-16&Address.endDate=1990-03-17&Address.confirmDelete=true
Response
{
"updateAddressResponse": {
"operationResult": "SUCCESS",
"responseDateTime": "2012-12-27T20:47:29.926-06:00",
"addressId": 3330
}
}
SOAP
Request
<soapenv:envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:neon="http://www.z2systems.com/schemas/neonws/">
<soapenv:header>
<soapenv:body>
<neon:updateaddressrequest>
<usersessionid>T1357624094982</usersessionid>
<accountid>5786</accountid>
<address>
<addressid>1588</addressid>
<isprimaryaddress>false</isprimaryaddress>
<isshippingaddress>false</isshippingaddress>
<shippingcompanyname></shippingcompanyname>
<shippingdeliverto></shippingdeliverto>
<addresstype>
<name>Home</name>
</addresstype>
<addressline1>14/29 mars ST</addressline1>
<addressline2></addressline2>
<addressline3></addressline3>
<addressline4></addressline4>
<city>cheng</city>
<state>
<name>ALABAMA</name>
</state>
<province></province>
<county></county>
<country>
<id>1</id>
</country>
<zipcode>6489</zipcode>
<zipcodesuffix>1</zipcodesuffix>
<startdate>2012-12-23</startdate>
<enddate>2013-04-21</enddate>
</address>
</neon:updateaddressrequest>
</soapenv:body>
</soapenv:header>
</soapenv:envelope>
Response
<soap:envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:body>
<ns2:updateaddressresponse xmlns:ns2="http://www.z2systems.com/schemas/neonws/">
<operationresult>SUCCESS</operationresult>
<responsedatetime>2013-01-08T01:42:23.854-06:00</responsedatetime>
<addressid>1588</addressid>
</ns2:updateaddressresponse>
</soap:body>
</soap:envelope>
Request Parameters
Name |
Required |
Description |
accountId |
Yes |
Account ID |
Address.addressId |
Yes |
ID of the address to be updated. |
Address.isPrimaryAddress |
|
Possible values: true, false. Default value is false. |
Address.isShippingAddress |
|
Possible values: true, false. |
Address.shippingCompanyName |
|
|
Address.shippingDeliverTo |
|
|
Address.addressType.id |
|
Possible values can be retrieved from the List Address Types request. Either ID or Name is required. |
Address.addressType.name |
|
Possible values can be retrieved from the List Address Types request. Either ID or Name is required. |
Address.addressLine1 |
|
Corresponds to the Street 1 field. |
Address.addressLine2 |
|
Corresponds to the Street 2 field. |
Address.addressLine3 |
|
Corresponds to the Street 3 field. |
Address.addressLine4 |
|
Corresponds to the Street 4 field. |
Address.city |
|
City |
Address.state.code |
|
Possible values can be retrieved from the List States method. Submit either a state code or state name. |
Address.state.name |
|
Possible values can be retrieved from the List States method. Submit either a state code or state name. |
Address.province |
|
Province. Canadian provinces can be found in the State field. Use this for provinces outside of US/Canada. Note: If you send a value for either state.code or state.name, the value in the province field will be ignored. |
Address.county |
|
County |
Address.country.id |
|
Possible values can be retrieved from the List Countries request. |
Address.country.name |
|
Possible values can be retrieved from the List Countries request. |
Address.zipCode |
|
|
Address.zipCodeSuffix |
|
The 4-digit zip code suffix. |
Address.startDate |
|
Use format YYYY-MM-DD. |
Address.endDate |
|
Use format YYYY-MM-DD. |
Response Parameters
Name |
Required |
Description |
addressId |
Yes |
Address ID |
Error Codes
Code |
Text |
Description |
10130 |
Address type is invalid. |
|
10131 |
Account id is required. |
|
10132 |
Account id is invalid. |
|
10133 |
Address country is invalid. |
|
10134 |
Address state is invalid. |
|
10135 |
Address id is required. |
|
10136 |
Address id is invalid. |
|
10137 |
Address id is invalid. Given address id does not belong to this primary contact. |
|
10138 |
Address cannot be empty. |
|
10139 |
Account id is invalid. Cannot add/update/remove address for organization account. Please refer to linkIndividualToOrganizationAccount and removeIndividualFromOrganizationAccount requests. |
|