PATCH | /User/Account/Settings/Client |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
SafeMode | query | bool? | No | |
IsSpotlightFeatureEnabled | query | bool? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
IsSpotlightFeaturedEnabled | form | bool | No | Determines if the user has the Spotlight popup enabled. |
SafeMode | form | bool | No | Determines if the user has SafeMode enabled. |
FileUploadLimit | form | int | No | The maximum file upload size supported. |
IsImageReplyEnabled | form | bool | No | If true allow reply with Gif or Image in all comments (and comment replies), as well as allow Gifs in Messenger. |
Grants | form | ClientGrants | No | Client features settings |
IsIgnoreConversationEnabled | form | bool | No | If true the ignore confersation feature is active. |
IsGiftingEnabled | form | bool | No | If true the Store Credit / Gifting feature is active. |
IsUserPhotoCommentsEnabled | form | bool | No | If true show the comment button on user photos. |
UserVideoSizeLimit | form | int | No | The maximum user video upload size supported (bytes). |
CommunityVideoSizeLimit | form | int | No | The maximum community video upload size supported (bytes). |
IsVideoMessageEnabled | form | bool | No | If true the Video messaging is active. |
MobileValidationNumber | form | string | No | Mobile number for manual validation. |
UserVideoUploadMaxRetries | form | int | No | The number of times to poll when merging a Video. |
UserVideoUploadPollInterval | form | int | No | The number milliseconds between polls when merging a Video. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Prospects | form | ProspectGrants | No | |
Photo | form | PhotoGrants | No | |
Message | form | MessageGrants | No | |
Event | form | EventGrants | No | |
Group | form | GroupGrants | No | |
Profile | form | PofileGrants | No | |
Community | form | CommunityGrants | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CanViewLikes | form | bool | No | |
CanViewMatches | form | bool | No | |
CanRemoveLike | form | bool | No | |
CanRemoveFav | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
UploadRequired | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
AUVisaRequired | form | bool | No | |
ShowReplyLimit | form | bool | No | |
CanMakeVideoCalls | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CanViewContacts | form | bool | No | |
CanCreateEvent | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CanManageGroups | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CanViewPhoneNumbers | form | bool | No | |
CanUseAnonymousBrowsing | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ArticleCanComment | form | bool | No | |
EventCanComment | form | bool | No | |
StoryCanComment | form | bool | No | |
ForumCanComment | form | bool | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>