PUT api/ResidentNotificationOptOut?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}

Put Notification OptOut Flag and Email Address

Request Information

URI Parameters

NameDescriptionTypeAdditional information
VendorID

string

Required

VendorPassword

string

Required

APIGUID

string

Required

Body Parameters

ResidentContactOptOut structure

ResidentContactOptOut
NameDescriptionTypeAdditional information
ResidentContactKey

integer

None.

rc_Email

string

None.

rc_OptOutPersonalInformation

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "ResidentContactKey": 1,
  "rc_Email": "sample string 2",
  "rc_OptOutPersonalInformation": true
}

application/xml, text/xml

Sample:
<ResidentContactOptOut xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VMSRXChange.DataClassesResident">
  <ResidentContactKey>1</ResidentContactKey>
  <rc_Email>sample string 2</rc_Email>
  <rc_OptOutPersonalInformation>true</rc_OptOutPersonalInformation>
</ResidentContactOptOut>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.