Skip to content
This repository has been archived by the owner on Jun 27, 2024. It is now read-only.

Commit

Permalink
GITBOOK-1241: fix endpoints
Browse files Browse the repository at this point in the history
  • Loading branch information
Funke Olasupo authored and gitbook-bot committed Feb 9, 2024
1 parent 28b58d0 commit 2969b11
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -306,7 +306,7 @@
* [Convert Channel to Team](reference/api/rest-api/endpoints/rooms/channels-endpoints/convert-channel-to-team.md)
* [Rooms Endpoints](reference/api/rest-api/endpoints/rooms/rooms-endpoints/README.md)
* [Set Room Notifications](reference/api/rest-api/endpoints/rooms/rooms-endpoints/set-room-notifications.md)
* [Get Room Admins](reference/api/rest-api/endpoints/rooms/rooms-endpoints/get-room-admins.md)
* [Get Admin Rooms](reference/api/rest-api/endpoints/rooms/rooms-endpoints/get-room-admins.md)
* [Clear Room History](reference/api/rest-api/endpoints/rooms/rooms-endpoints/clear-room-history.md)
* [Get Room Information](reference/api/rest-api/endpoints/rooms/rooms-endpoints/get-room-information.md)
* [Get Room Discussions](reference/api/rest-api/endpoints/rooms/rooms-endpoints/get-room-discussions.md)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Any of the following errors can occur on the endpoint.

* **Authorization**: Requires an authentication token for the request to be made.
* **Not Allowed**: This occurs when the authenticated user doesn't have the `set-owner` permission.
* **User is already a moderator**: This occurs when the user is already a owner in the channel.
* **User is already an owner**: This occurs when the user is already a owner in the channel.

{% tabs %}
{% tab title="Authorization" %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Sets the notification settings of a specific room.

## Body Parameters

<table><thead><tr><th width="204.33333333333331">Key</th><th width="231">Example Value</th><th>Description</th></tr></thead><tbody><tr><td><code>roomId</code><mark style="color:red;"><code>*</code></mark></td><td><code>5of4weEXaH7yncxz9</code></td><td>The channel's id</td></tr><tr><td><code>notifications</code><mark style="color:red;"><code>*</code></mark></td><td><code>"notifications": {...}</code></td><td>The object that contains the following parameters.</td></tr><tr><td><code>desktopNotifications</code></td><td><code>nothing</code></td><td><p>The value for desktop notifications. The options are:</p><ul><li><code>nothing</code></li><li><code>mentions</code></li><li><code>all</code></li><li><code>default</code></li></ul></td></tr><tr><td><code>disableNotifications</code></td><td><code>0</code></td><td><p>The value to disable/enable channel's notifications. </p><p>The options are:</p><ul><li><code>0</code></li><li><code>1</code></li></ul></td></tr><tr><td><code>emailNotifications</code></td><td><code>nothing</code></td><td><p>The value for email notifications. </p><p>The options are:</p><ul><li><code>nothing</code></li><li><code>mentions</code></li><li><code>all</code></li><li><code>default</code></li></ul></td></tr><tr><td><code>audioNotifications</code></td><td><code>nothing</code></td><td><p>The value for audio notifications. </p><p>The options are:</p><ul><li><code>nothing</code></li><li><code>mentions</code></li><li><code>all</code></li><li><code>default</code></li></ul></td></tr><tr><td><code>notifications.mobilePushNotifications</code></td><td><code>nothing</code></td><td><p>The value for mobile push notifications. </p><p>The options are:</p><ul><li><code>nothing</code></li><li><code>mentions</code></li><li><code>all</code></li><li><code>default</code></li></ul></td></tr><tr><td><code>audioNotificationValue</code></td><td><code>beep</code></td><td>The value for audio notification sound.</td></tr><tr><td><code>desktopNotificationDuration</code></td><td><code>0</code></td><td>The value for desktop notification duration.</td></tr><tr><td><code>unreadAlert</code></td><td><code>nothing</code></td><td><p>The value for unread alerts notifications. </p><p>The options are:</p><ul><li><code>nothing</code></li><li><code>mentions</code></li><li><code>all</code></li><li><code>default</code></li></ul></td></tr><tr><td><code>hideUnreadStatus</code></td><td><code>0</code></td><td><p>The value to disable/enable number of unread messages. </p><p>The options are:</p><ul><li><code>0</code></li><li><code>1</code></li></ul></td></tr></tbody></table>
<table><thead><tr><th width="204.33333333333331">Key</th><th width="231">Example Value</th><th>Description</th></tr></thead><tbody><tr><td><code>roomId</code><mark style="color:red;"><code>*</code></mark></td><td><code>5of4weEXaH7yncxz9</code></td><td>The channel's id</td></tr><tr><td><code>notifications</code><mark style="color:red;"><code>*</code></mark></td><td><code>"notifications": {...}</code></td><td>The object that contains the following parameters.</td></tr><tr><td><code>desktopNotifications</code></td><td><code>nothing</code></td><td><p>The value for desktop notifications. The options are:</p><ul><li><code>nothing</code></li><li><code>mentions</code></li><li><code>all</code></li><li><code>default</code></li></ul></td></tr><tr><td><code>disableNotifications</code></td><td><code>0</code></td><td><p>The value to disable/enable channel's notifications. </p><p>The options are:</p><ul><li><code>0</code></li><li><code>1</code></li></ul></td></tr><tr><td><code>emailNotifications</code></td><td><code>nothing</code></td><td><p>The value for email notifications. </p><p>The options are:</p><ul><li><code>nothing</code></li><li><code>mentions</code></li><li><code>all</code></li><li><code>default</code></li></ul></td></tr><tr><td><code>audioNotifications</code></td><td><code>nothing</code></td><td><p>The value for audio notifications. </p><p>The options are:</p><ul><li><code>nothing</code></li><li><code>mentions</code></li><li><code>all</code></li><li><code>default</code></li></ul></td></tr><tr><td><code>mobilePushNotifications</code></td><td><code>nothing</code></td><td><p>The value for mobile push notifications. </p><p>The options are:</p><ul><li><code>nothing</code></li><li><code>mentions</code></li><li><code>all</code></li><li><code>default</code></li></ul></td></tr><tr><td><code>audioNotificationValue</code></td><td><code>beep</code></td><td>The value for audio notification sound.</td></tr><tr><td><code>desktopNotificationDuration</code></td><td><code>0</code></td><td>The value for desktop notification duration.</td></tr><tr><td><code>unreadAlert</code></td><td><code>nothing</code></td><td><p>The value for unread alerts notifications. </p><p>The options are:</p><ul><li><code>nothing</code></li><li><code>mentions</code></li><li><code>all</code></li><li><code>default</code></li></ul></td></tr><tr><td><code>hideUnreadStatus</code></td><td><code>0</code></td><td><p>The value to disable/enable number of unread messages. </p><p>The options are:</p><ul><li><code>0</code></li><li><code>1</code></li></ul></td></tr></tbody></table>

## Example Call

Expand Down

0 comments on commit 2969b11

Please sign in to comment.