RHP_API

<back to all web services

PatchClientChatroomSettings

Update the user client messenger settings.

Requires Authentication
The following routes are available for this service:
PATCH/User/Account/Settings/Chatroom
PatchClientChatroomSettings Parameters:
NameParameterData TypeRequiredDescription
PermissionMessageReceivequeryChatroomMessageReceivePermission?No
IsSoundEnabledquerybool?No
ChatroomSettings Parameters:
NameParameterData TypeRequiredDescription
PermissionMessageReceiveformChatroomMessageReceivePermissionNoDetermine's who the user can receive message from.
IsSoundEnabledformboolNoDetermine's if the user wants the sounds to play.
IsActiveformboolNoIf true the client should display the 'Service Unavailable' popup.

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

{"PermissionMessageReceive":"Anyone","IsSoundEnabled":false}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"PermissionMessageReceive":"Anyone","IsSoundEnabled":false,"IsActive":false}