RHP_API

PatchClientMessengerSettings

Update the user client messenger settings.

The following routes are available for this service:
PATCH	/User/Account/Settings/Messenger

**PatchClientMessengerSettings** Parameters:
Name	Parameter	Data Type	Required
PermissionMessageReceive	query	MessageReceivePermission?	No
PermissionVideoCall	query	MessageReceivePermission?	No
DefaultFolder	query	MessageFolders?	No
DefaultImageDuration	query	MessageImageDuration	No
CanReceivePhotos	query	bool?	No
CanReceiveGifts	query	bool?	No
Theme	query	MessengerTheme	No

**MessengerTheme** Parameters:
Name	Parameter	Data Type	Required	Description
DarkMode	form	bool	No	DEPRECATED. Replaced with DarkModeSetting
DarkModeSetting	form	ToggleWithDefault	No
ThemeType	form	MessengerThemeType	No
FontSize	form	MessengerFontSize	No

**MessengerSettings** Parameters:
Name	Parameter	Data Type	Required	Description
PermissionMessageReceive	form	MessageReceivePermission	No	Determines if a user can receive a message.
PermissionVideoCall	form	MessageReceivePermission	No	Determines if a user can receive a video call.
ReplyLimitDays	form	int	No	The number of days that a user can reply after the last received message in a conversation, if less than one is returned there is no limit.
DefaultFolder	form	MessageFolders	No
OperationMethod	form	string	No
DefaultImageDuration	form	MessageImageDuration	No	Default image shared duration.
CanReceivePhotos	form	bool	No
CanReceiveGifts	form	bool	No
IsActive	form	bool?	No	If true the client should display the 'Service Unavailable' popup.
Theme	form	MessengerTheme	No

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

<PatchClientMessengerSettings xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RHP_API.ServiceModel">
  <CanReceiveGifts>false</CanReceiveGifts>
  <CanReceivePhotos>false</CanReceivePhotos>
  <DefaultFolder>All</DefaultFolder>
  <DefaultImageDuration>None</DefaultImageDuration>
  <PermissionMessageReceive>Anyone</PermissionMessageReceive>
  <PermissionVideoCall>Anyone</PermissionVideoCall>
  <Theme xmlns:d2p1="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">
    <d2p1:DarkMode>false</d2p1:DarkMode>
    <d2p1:DarkModeSetting>Default</d2p1:DarkModeSetting>
    <d2p1:FontSize>Small</d2p1:FontSize>
    <d2p1:ThemeType>Green</d2p1:ThemeType>
  </Theme>
</PatchClientMessengerSettings>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<MessengerSettings xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">
  <CanReceiveGifts>false</CanReceiveGifts>
  <CanReceivePhotos>false</CanReceivePhotos>
  <DefaultFolder>All</DefaultFolder>
  <DefaultImageDuration>None</DefaultImageDuration>
  <IsActive>false</IsActive>
  <OperationMethod>String</OperationMethod>
  <PermissionMessageReceive>Anyone</PermissionMessageReceive>
  <PermissionVideoCall>Anyone</PermissionVideoCall>
  <ReplyLimitDays>0</ReplyLimitDays>
  <Theme>
    <DarkMode>false</DarkMode>
    <DarkModeSetting>Default</DarkModeSetting>
    <FontSize>Small</FontSize>
    <ThemeType>Green</ThemeType>
  </Theme>
</MessengerSettings>