Back to Developer Center

API v1 Reference

Delete Household

This removes a household record. It does not delete any accounts associated with the household.

REST

Request

https://api.neoncrm.com/neonws/services/api/account/deleteHouseHold?userSessionId=[session id]&houseHoldId=12

Response

{ "deleteHouseHoldResponse": { 
    "operationResult": "SUCCESS", 
    "responseMessage": "HouseHold deleted.", 
    "responseDateTime": "2012-12-27T02:33:28.456-06:00" } 
}

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:deletehouseholdrequest>
             <usersessionid>T1357624094982</usersessionid>
             <householdid>27</householdid>
          </neon:deletehouseholdrequest>
       </soapenv:body>
    </soapenv:header>
</soapenv:envelope>

Response

<soap:envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:body>
      <ns2:deletehouseholdresponse xmlns:ns2="http://www.z2systems.com/schemas/neonws/">
         <operationresult>SUCCESS</operationresult>
         <responsemessage>HouseHold deleted.</responsemessage>
         <responsedatetime>2013-01-08T00:22:15.620-06:00</responsedatetime>
      </ns2:deletehouseholdresponse>
   </soap:body>
</soap:envelope>

Request Parameters

Name Required Description
houseHoldId Yes The ID of the household to be deleted.

Error Codes

Code Text Description
10159 Household id is required.
10160 Household id is invalid.