RHP_API

<back to all web services

PatchClientMessengerSettings

Update the user client messenger settings.

Requires Authentication
The following routes are available for this service:
PATCH/User/Account/Settings/Messenger
PatchClientMessengerSettings Parameters:
NameParameterData TypeRequiredDescription
PermissionMessageReceivequeryMessageReceivePermission?No
PermissionVideoCallqueryMessageReceivePermission?No
DefaultFolderqueryMessageFolders?No
DefaultImageDurationqueryMessageImageDurationNo
CanReceivePhotosquerybool?No
CanReceiveGiftsquerybool?No
ThemequeryMessengerThemeNo
MessengerTheme Parameters:
NameParameterData TypeRequiredDescription
DarkModeformboolNoDEPRECATED. Replaced with DarkModeSetting
DarkModeSettingformToggleWithDefaultNo
ThemeTypeformMessengerThemeTypeNo
FontSizeformMessengerFontSizeNo
MessengerSettings Parameters:
NameParameterData TypeRequiredDescription
PermissionMessageReceiveformMessageReceivePermissionNoDetermines if a user can receive a message.
PermissionVideoCallformMessageReceivePermissionNoDetermines if a user can receive a video call.
ReplyLimitDaysformintNoThe 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.
DefaultFolderformMessageFoldersNo
OperationMethodformstringNo
DefaultImageDurationformMessageImageDurationNoDefault image shared duration.
CanReceivePhotosformboolNo
CanReceiveGiftsformboolNo
IsActiveformbool?NoIf true the client should display the 'Service Unavailable' popup.
ThemeformMessengerThemeNo

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

{"PermissionMessageReceive":"Anyone","PermissionVideoCall":"Anyone","DefaultFolder":"All","DefaultImageDuration":"None","CanReceivePhotos":false,"CanReceiveGifts":false,"Theme":{"DarkMode":false,"DarkModeSetting":"Default","ThemeType":"Green","FontSize":"Small"}}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"PermissionMessageReceive":"Anyone","PermissionVideoCall":"Anyone","ReplyLimitDays":0,"DefaultFolder":"All","OperationMethod":"String","DefaultImageDuration":"None","CanReceivePhotos":false,"CanReceiveGifts":false,"IsActive":false,"Theme":{"DarkMode":false,"DarkModeSetting":"Default","ThemeType":"Green","FontSize":"Small"}}