RHP_API

<back to all web services

PatchUserClientSettings

Update the user client settings.

Requires Authentication
The following routes are available for this service:
PATCH/User/Account/Settings/Client
PatchUserClientSettings Parameters:
NameParameterData TypeRequiredDescription
SafeModequerybool?No
IsSpotlightFeatureEnabledquerybool?No
ClientSettings Parameters:
NameParameterData TypeRequiredDescription
IsSpotlightFeaturedEnabledformboolNoDetermines if the user has the Spotlight popup enabled.
SafeModeformboolNoDetermines if the user has SafeMode enabled.
FileUploadLimitformintNoThe maximum file upload size supported.
IsImageReplyEnabledformboolNoIf true allow reply with Gif or Image in all comments (and comment replies), as well as allow Gifs in Messenger.
GrantsformClientGrantsNoClient features settings
IsIgnoreConversationEnabledformboolNoIf true the ignore confersation feature is active.
IsGiftingEnabledformboolNoIf true the Store Credit / Gifting feature is active.
IsUserPhotoCommentsEnabledformboolNoIf true show the comment button on user photos.
UserVideoSizeLimitformintNoThe maximum user video upload size supported (bytes).
CommunityVideoSizeLimitformintNoThe maximum community video upload size supported (bytes).
IsVideoMessageEnabledformboolNoIf true the Video messaging is active.
MobileValidationNumberformstringNoMobile number for manual validation.
UserVideoUploadMaxRetriesformintNoThe number of times to poll when merging a Video.
UserVideoUploadPollIntervalformintNoThe number milliseconds between polls when merging a Video.
ClientGrants Parameters:
NameParameterData TypeRequiredDescription
ProspectsformProspectGrantsNo
PhotoformPhotoGrantsNo
MessageformMessageGrantsNo
EventformEventGrantsNo
GroupformGroupGrantsNo
ProfileformPofileGrantsNo
CommunityformCommunityGrantsNo
ProspectGrants Parameters:
NameParameterData TypeRequiredDescription
CanViewLikesformboolNo
CanViewMatchesformboolNo
CanRemoveLikeformboolNo
CanRemoveFavformboolNo
PhotoGrants Parameters:
NameParameterData TypeRequiredDescription
UploadRequiredformboolNo
MessageGrants Parameters:
NameParameterData TypeRequiredDescription
AUVisaRequiredformboolNo
ShowReplyLimitformboolNo
CanMakeVideoCallsformboolNo
EventGrants Parameters:
NameParameterData TypeRequiredDescription
CanViewContactsformboolNo
CanCreateEventformboolNo
GroupGrants Parameters:
NameParameterData TypeRequiredDescription
CanManageGroupsformboolNo
PofileGrants Parameters:
NameParameterData TypeRequiredDescription
CanViewPhoneNumbersformboolNo
CanUseAnonymousBrowsingformboolNo
CommunityGrants Parameters:
NameParameterData TypeRequiredDescription
ArticleCanCommentformboolNo
EventCanCommentformboolNo
StoryCanCommentformboolNo
ForumCanCommentformboolNo

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/Client HTTP/1.1 
Host: tstsrvs.redhotpie.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PatchUserClientSettings xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RHP_API.ServiceModel">
  <IsSpotlightFeatureEnabled>false</IsSpotlightFeatureEnabled>
  <SafeMode>false</SafeMode>
</PatchUserClientSettings>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ClientSettings xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">
  <CommunityVideoSizeLimit>0</CommunityVideoSizeLimit>
  <FileUploadLimit>0</FileUploadLimit>
  <Grants>
    <Community>
      <ArticleCanComment>false</ArticleCanComment>
      <EventCanComment>false</EventCanComment>
      <ForumCanComment>false</ForumCanComment>
      <StoryCanComment>false</StoryCanComment>
    </Community>
    <Event>
      <CanCreateEvent>false</CanCreateEvent>
      <CanViewContacts>false</CanViewContacts>
    </Event>
    <Group>
      <CanManageGroups>false</CanManageGroups>
    </Group>
    <Message>
      <AUVisaRequired>false</AUVisaRequired>
      <CanMakeVideoCalls>false</CanMakeVideoCalls>
      <ShowReplyLimit>false</ShowReplyLimit>
    </Message>
    <Photo>
      <UploadRequired>false</UploadRequired>
    </Photo>
    <Profile>
      <CanUseAnonymousBrowsing>false</CanUseAnonymousBrowsing>
      <CanViewPhoneNumbers>false</CanViewPhoneNumbers>
    </Profile>
    <Prospects>
      <CanRemoveFav>false</CanRemoveFav>
      <CanRemoveLike>false</CanRemoveLike>
      <CanViewLikes>false</CanViewLikes>
      <CanViewMatches>false</CanViewMatches>
    </Prospects>
  </Grants>
  <IsGiftingEnabled>false</IsGiftingEnabled>
  <IsIgnoreConversationEnabled>false</IsIgnoreConversationEnabled>
  <IsImageReplyEnabled>false</IsImageReplyEnabled>
  <IsSpotlightFeaturedEnabled>false</IsSpotlightFeaturedEnabled>
  <IsUserPhotoCommentsEnabled>false</IsUserPhotoCommentsEnabled>
  <IsVideoMessageEnabled>false</IsVideoMessageEnabled>
  <MobileValidationNumber>String</MobileValidationNumber>
  <SafeMode>false</SafeMode>
  <UserVideoSizeLimit>0</UserVideoSizeLimit>
  <UserVideoUploadMaxRetries>0</UserVideoUploadMaxRetries>
  <UserVideoUploadPollInterval>0</UserVideoUploadPollInterval>
</ClientSettings>