POST api/ResidentContact?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}
Post ResidentContact record
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| VendorID | string |
Required |
|
| VendorPassword | string |
Required |
|
| APIGUID | string |
Required |
Body Parameters
ResidentContact structure
ResidentContactUpdate| Name | Description | Type | Additional information |
|---|---|---|---|
| ResidentContactKey | integer |
None. |
|
| ResidentKey | integer |
None. |
|
| rc_VotingContact | boolean |
None. |
|
| rc_Type | integer |
None. |
|
| rc_SendMail | boolean |
None. |
|
| rc_LastName | string |
None. |
|
| rc_FirstName | string |
None. |
|
| rc_Address | string |
None. |
|
| rc_Address2 | string |
None. |
|
| rc_City | string |
None. |
|
| rc_State | string |
None. |
|
| rc_Zipcode | string |
None. |
|
| rc_URL | string |
None. |
|
| rc_Email | string |
None. |
|
| rc_Disabled | boolean |
None. |
|
| rc_SendCalendarEvent | boolean |
None. |
|
| rc_SendClassified | boolean |
None. |
|
| rc_SendLatePayment | boolean |
None. |
|
| rc_SendPayment | boolean |
None. |
|
| rc_ViolationNotice | boolean |
None. |
|
| rc_Private | boolean |
None. |
|
| rc_SendSurvey | boolean |
None. |
|
| rc_SendNews | boolean |
None. |
|
| rc_Note | string |
None. |
|
| rc_Date1 | date |
None. |
|
| rc_Date2 | date |
None. |
|
| rc_Date3 | date |
None. |
|
| rc_Date4 | date |
None. |
|
| rc_Date5 | date |
None. |
|
| rc_SecretWordType | string |
None. |
|
| rc_Salutation | string |
None. |
|
| rc_Country | string |
None. |
|
| rc_Owner | boolean |
None. |
|
| rc_International | boolean |
None. |
|
| rc_SendArchitectural | boolean |
None. |
|
| rc_SendWorkOrder | boolean |
None. |
|
| rc_CollectionResidentContactKey | integer |
None. |
|
| rc_County | string |
None. |
|
| rc_OptOutPersonalInformation | boolean |
None. |
|
| rc_SynchronizeInformation | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"ResidentContactKey": 1,
"ResidentKey": 2,
"rc_VotingContact": true,
"rc_Type": 4,
"rc_SendMail": true,
"rc_LastName": "sample string 6",
"rc_FirstName": "sample string 7",
"rc_Address": "sample string 8",
"rc_Address2": "sample string 9",
"rc_City": "sample string 10",
"rc_State": "sample string 11",
"rc_Zipcode": "sample string 12",
"rc_URL": "sample string 13",
"rc_Email": "sample string 14",
"rc_Disabled": true,
"rc_SendCalendarEvent": true,
"rc_SendClassified": true,
"rc_SendLatePayment": true,
"rc_SendPayment": true,
"rc_ViolationNotice": true,
"rc_Private": true,
"rc_SendSurvey": true,
"rc_SendNews": true,
"rc_Note": "sample string 24",
"rc_Date1": "2025-10-27T12:15:10.7882406-07:00",
"rc_Date2": "2025-10-27T12:15:10.7882406-07:00",
"rc_Date3": "2025-10-27T12:15:10.7882406-07:00",
"rc_Date4": "2025-10-27T12:15:10.7882406-07:00",
"rc_Date5": "2025-10-27T12:15:10.7882406-07:00",
"rc_SecretWordType": "sample string 30",
"rc_Salutation": "sample string 31",
"rc_Country": "sample string 32",
"rc_Owner": true,
"rc_International": true,
"rc_SendArchitectural": true,
"rc_SendWorkOrder": true,
"rc_CollectionResidentContactKey": 37,
"rc_County": "sample string 38",
"rc_OptOutPersonalInformation": true,
"rc_SynchronizeInformation": true
}
application/xml, text/xml
Sample:
<ResidentContactUpdate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VMSRXChange.DataClassesResident"> <ResidentContactKey>1</ResidentContactKey> <ResidentKey>2</ResidentKey> <rc_Address>sample string 8</rc_Address> <rc_Address2>sample string 9</rc_Address2> <rc_City>sample string 10</rc_City> <rc_CollectionResidentContactKey>37</rc_CollectionResidentContactKey> <rc_Country>sample string 32</rc_Country> <rc_County>sample string 38</rc_County> <rc_Date1>2025-10-27T12:15:10.7882406-07:00</rc_Date1> <rc_Date2>2025-10-27T12:15:10.7882406-07:00</rc_Date2> <rc_Date3>2025-10-27T12:15:10.7882406-07:00</rc_Date3> <rc_Date4>2025-10-27T12:15:10.7882406-07:00</rc_Date4> <rc_Date5>2025-10-27T12:15:10.7882406-07:00</rc_Date5> <rc_Disabled>true</rc_Disabled> <rc_Email>sample string 14</rc_Email> <rc_FirstName>sample string 7</rc_FirstName> <rc_International>true</rc_International> <rc_LastName>sample string 6</rc_LastName> <rc_Note>sample string 24</rc_Note> <rc_OptOutPersonalInformation>true</rc_OptOutPersonalInformation> <rc_Owner>true</rc_Owner> <rc_Private>true</rc_Private> <rc_Salutation>sample string 31</rc_Salutation> <rc_SecretWordType>sample string 30</rc_SecretWordType> <rc_SendArchitectural>true</rc_SendArchitectural> <rc_SendCalendarEvent>true</rc_SendCalendarEvent> <rc_SendClassified>true</rc_SendClassified> <rc_SendLatePayment>true</rc_SendLatePayment> <rc_SendMail>true</rc_SendMail> <rc_SendNews>true</rc_SendNews> <rc_SendPayment>true</rc_SendPayment> <rc_SendSurvey>true</rc_SendSurvey> <rc_SendWorkOrder>true</rc_SendWorkOrder> <rc_State>sample string 11</rc_State> <rc_SynchronizeInformation>true</rc_SynchronizeInformation> <rc_Type>4</rc_Type> <rc_URL>sample string 13</rc_URL> <rc_ViolationNotice>true</rc_ViolationNotice> <rc_VotingContact>true</rc_VotingContact> <rc_Zipcode>sample string 12</rc_Zipcode> </ResidentContactUpdate>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |