PATCH | /User/Account/Settings/Messenger |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
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 |
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 |
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 .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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"}}