PUT Users/UsersApi/UpsertPreferences
Request Information
URI Parameters
None.
Body Parameters
PreferencesInputModel| Name | Description | Type | Additional information |
|---|---|---|---|
| UserId | globally unique identifier |
None. |
|
| Status | string |
None. |
|
| StatusTime | date |
None. |
|
| Snooze | SnoozeSettings |
None. |
|
| Notifications | NotificatonPreferences |
None. |
|
| IsArchieved | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"UserId": "733c57d4-a5d8-480f-b6f9-2cd9589ec81b",
"Status": "sample string 1",
"StatusTime": "2025-12-14T01:30:48.976351+00:00",
"Snooze": {
"Paused": true,
"PausedFor": 1,
"PausedOn": "2025-12-14T01:30:48.9773813+00:00"
},
"Notifications": {
"All": true,
"Messages": true,
"Mentions": true,
"Announcements": true,
"Reactions": true,
"Emails": true
},
"IsArchieved": true
}
application/xml, text/xml
Sample:
<PreferencesInputModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Communicator.Models.Users">
<IsArchieved>true</IsArchieved>
<Notifications>
<All>true</All>
<Announcements>true</Announcements>
<Emails>true</Emails>
<Mentions>true</Mentions>
<Messages>true</Messages>
<Reactions>true</Reactions>
</Notifications>
<Snooze>
<Paused>true</Paused>
<PausedFor>1</PausedFor>
<PausedOn>2025-12-14T01:30:48.9773813+00:00</PausedOn>
</Snooze>
<Status>sample string 1</Status>
<StatusTime>2025-12-14T01:30:48.976351+00:00</StatusTime>
<UserId>733c57d4-a5d8-480f-b6f9-2cd9589ec81b</UserId>
</PreferencesInputModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
JsonResultOfCommunicatorJsonResult| Name | Description | Type | Additional information |
|---|---|---|---|
| Content | CommunicatorJsonResult |
None. |
|
| SerializerSettings | JsonSerializerSettings |
None. |
|
| Encoding | Encoding |
None. |
|
| Request | HttpRequestMessage |
None. |
Response Formats
application/json, text/json
Sample:
Sample not available.