RHP_API

<back to all web services

PatchAccountSettings

Update the user client messenger settings.

Requires Authentication
The following routes are available for this service:
PATCH/User/Account/Settings/Account
PatchAccountSettings Parameters:
NameParameterData TypeRequiredDescription
ProfileViewablequerybool?No
ShowOnlinequerybool?No
AnonymousBrowsingquerybool?No
ReceiveEmailMessagesquerybool?No
FeatureProfilequerybool?No
PromoteProfilequerybool?No
ProfileViewSettingsqueryProfileViewSettings?No
ValidationViewSettingqueryProfileViewSettings?No
IntimateInfoViewSettingsqueryProfileViewSettings?No
ProfileActivityViewSettingsqueryProfileViewSettings?No
AccountSettings Parameters:
NameParameterData TypeRequiredDescription
ProfileViewableformboolNo
ShowOnlineformboolNo
AnonymousBrowsingformboolNo
ReceiveEmailMessagesformboolNoThis parameter is deprecated, use email settings
AccountStatusformAccountStatusNoAccountStatus indicates the status of a user account
AccountPausedformboolNoThis parameter is deprecated, use AccountStatus
AccountRequiresAuthenticationformboolNoThis parameter is deprecated, use AccountStatus
EmailNotificationSettingsformEmailNotificationSettingsNo
NewPasswordRequiredformboolNo
FeatureProfileformboolNo
PromoteProfileformboolNo
ProfileBoostExpiryformDateTime?No
ProfileViewSettingsformProfileViewSettingsNo
ShareProfileCodeformstringNo
ValidationViewSettingformProfileViewSettingsNo
IntimateInfoViewSettingsformProfileViewSettingsNo
ProfileActivityViewSettingsformProfileViewSettingsNo
AccountDeletedDateformDateTime?No
GCLIDformstringNo
EmailNotificationSettings Parameters:
NameParameterData TypeRequiredDescription
MatchReportformboolNo
DateFinderformboolNo
EventsformboolNo
OffersformboolNo
RHPTeamMessagesformboolNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PATCH /User/Account/Settings/Account HTTP/1.1 
Host: tstsrvs.redhotpie.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PatchAccountSettings xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RHP_API.ServiceModel">
  <AnonymousBrowsing>false</AnonymousBrowsing>
  <FeatureProfile>false</FeatureProfile>
  <IntimateInfoViewSettings>Everyone</IntimateInfoViewSettings>
  <ProfileActivityViewSettings>Everyone</ProfileActivityViewSettings>
  <ProfileViewSettings>Everyone</ProfileViewSettings>
  <ProfileViewable>false</ProfileViewable>
  <PromoteProfile>false</PromoteProfile>
  <ReceiveEmailMessages>false</ReceiveEmailMessages>
  <ShowOnline>false</ShowOnline>
  <ValidationViewSetting>Everyone</ValidationViewSetting>
</PatchAccountSettings>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AccountSettings xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">
  <AccountDeletedDate>0001-01-01T00:00:00</AccountDeletedDate>
  <AccountPaused>false</AccountPaused>
  <AccountRequiresAuthentication>false</AccountRequiresAuthentication>
  <AccountStatus>Active</AccountStatus>
  <AnonymousBrowsing>false</AnonymousBrowsing>
  <EmailNotificationSettings>
    <DateFinder>false</DateFinder>
    <Events>false</Events>
    <MatchReport>false</MatchReport>
    <Offers>false</Offers>
    <RHPTeamMessages>false</RHPTeamMessages>
  </EmailNotificationSettings>
  <FeatureProfile>false</FeatureProfile>
  <GCLID>String</GCLID>
  <IntimateInfoViewSettings>Everyone</IntimateInfoViewSettings>
  <NewPasswordRequired>false</NewPasswordRequired>
  <ProfileActivityViewSettings>Everyone</ProfileActivityViewSettings>
  <ProfileBoostExpiry>0001-01-01T00:00:00</ProfileBoostExpiry>
  <ProfileViewSettings>Everyone</ProfileViewSettings>
  <ProfileViewable>false</ProfileViewable>
  <PromoteProfile>false</PromoteProfile>
  <ReceiveEmailMessages>false</ReceiveEmailMessages>
  <ShareProfileCode>String</ShareProfileCode>
  <ShowOnline>false</ShowOnline>
  <ValidationViewSetting>Everyone</ValidationViewSetting>
</AccountSettings>