diff --git a/Claude outputs/docs-1539-changes.diff b/Claude outputs/docs-1539-changes.diff new file mode 100644 index 0000000..5e4ff05 --- /dev/null +++ b/Claude outputs/docs-1539-changes.diff @@ -0,0 +1,223 @@ +--- /mnt/user-data/uploads/Rocket.Chat-Open-API/messaging.yaml 2026-09-08 19:37:16.270256865 +0000 ++++ patched-1539/messaging.yaml 2026-09-08 19:38:34.530255075 +0000 +@@ -2743,7 +2743,7 @@ + - Chat + summary: Send Message + description: |- +- The difference between `chat.postMessage` and `chat.sendMessage` is that `chat.sendMessage` allows for passing a value for `_id` and the other one doesn't. Also, `chat.sendMessage` only sends it to one channel whereas the other one allows for sending to more than one channel at a time.
++ The difference between `chat.postMessage` and `chat.sendMessage` is that `chat.sendMessage` allows for passing a value for `_id` and the other one doesn't. Also, `chat.sendMessage` only sends it to one channel whereas the other one allows for sending to more than one channel at a time. + + **Note**: You can only send alias and avatar properties if your user has the `message-impersonate permission`. We implemented this rule to avoid users impersonating other users. By default, only the bot role has this permission, but that can be changed in **Manage** -> **Permissions** -> **message-impersonate**. + +--- /mnt/user-data/uploads/Rocket.Chat-Open-API/omnichannel.yaml 2026-09-08 19:37:17.274256842 +0000 ++++ patched-1539/omnichannel.yaml 2026-09-08 19:38:34.543745640 +0000 +@@ -4052,7 +4052,7 @@ + description: |- +
Enterprise
+ +- Set the priority of an Omnichannel room.
++ Set the priority of an Omnichannel room. + + Permission required: `view-l-room` + +@@ -4118,7 +4118,7 @@ + description: |- +
Enterprise
+ +- Remove the priority set to an Omnichannel room.
++ Remove the priority set to an Omnichannel room. + + Permission required: `view-l-room` + +@@ -7222,7 +7222,7 @@ + description: |- +
Enterprise
+ +- Request a PDF transcript for an Omnichannel conversation. The conversation must be closed before it can be exported.
++ Request a PDF transcript for an Omnichannel conversation. The conversation must be closed before it can be exported. + + Permission required: `request-pdf-transcript`. + Omnichannel managers and agents have this permission by default. +@@ -12082,7 +12082,8 @@ + description: |- +
Enterprise
+ +- Get details of a specific unit.
++ Get details of a specific unit. ++ + Permission required: `manage-livechat-units` + tags: + - Omnichannel Units +@@ -12148,7 +12149,8 @@ + description: |- +
Enterprise
+ +- Get the list of monitors associated with a specific unit.
++ Get the list of monitors associated with a specific unit. ++ + Permission required: `manage-livechat-units` + tags: + - Omnichannel Units +@@ -12416,7 +12418,7 @@ + description: |- +
Enterprise
+ +- View the metrics of omnichannel conversations in your workspace during a selected time range based on their status: **Open**, **Queued**, **On Hold**, or **Closed**.
++ View the metrics of omnichannel conversations in your workspace during a selected time range based on their status: **Open**, **Queued**, **On Hold**, or **Closed**. + + Permission required: `view-livechat-reports` + +@@ -12480,7 +12482,7 @@ +
Enterprise
+ + +- View the metrics of omnichannel conversations in your workspace during a selected time range based on their departments.
++ View the metrics of omnichannel conversations in your workspace during a selected time range based on their departments. + + Permission required: `view-livechat-reports` + +@@ -12545,7 +12547,7 @@ + description: |- +
Enterprise
+ +- View the metrics of omnichannel conversations in your workspace during a selected time range based on their tags.
++ View the metrics of omnichannel conversations in your workspace during a selected time range based on their tags. + + Permission required: `view-livechat-reports` + +@@ -12612,7 +12614,7 @@ + +
Enterprise
+ +- View the metrics of omnichannel conversations in your workspace during a selected time range based on the agents in your workspace.
++ View the metrics of omnichannel conversations in your workspace during a selected time range based on the agents in your workspace. + + Permission required: `view-livechat-reports` + +@@ -12931,7 +12933,8 @@ + description: |- +
Enterprise
+ +- Get details of a specific SLA policy.
++ Get details of a specific SLA policy. ++ + At least one of the following permissions is required: + * `manage-livechat-sla` + * `view-l-room` +@@ -12990,7 +12993,8 @@ +
Enterprise
+ + +- Update an existing SLA policy.
++ Update an existing SLA policy. ++ + Permission required: `manage-livechat-sla` + + ### Changelog +@@ -14571,7 +14575,7 @@ + description: |- +
Enterprise
+ +- Get a list of all canned responses in the workspace that belong to the current user scope.
++ Get a list of all canned responses in the workspace that belong to the current user scope. + + Permission required: `view-canned-responses` + +@@ -14666,7 +14670,7 @@ + description: |- +
Enterprise
+ +- Get a specific canned response.
++ Get a specific canned response. + + Permission required: `view-canned-responses` + +@@ -14756,7 +14760,7 @@ + Use this endpoint to delete a canned response. Permission required: `remove-canned-responses` + + ### Changelog +- | Version | Description ++ | Version | Description | + | ---------------- | ------------| + |7.12.0 | Added | + parameters: +--- /mnt/user-data/uploads/Rocket.Chat-Open-API/rooms.yaml 2026-09-08 19:37:17.974256826 +0000 ++++ patched-1539/rooms.yaml 2026-09-08 19:38:34.554255075 +0000 +@@ -14659,7 +14659,7 @@ + before they can join via an invite token. + + ### Changelog +- | Version | Change | ++ | Version | Description | + |---------|--------| + | 8.4.0 | Added ban check — banned users can no longer join via invite token | + operationId: post-useInviteToken +@@ -16371,7 +16371,7 @@ + Permissions required: `abac-management` and `manage-abac-admin-settings`. + + ### Changelog +- | Version | Change | ++ | Version | Description | + |---------|--------| + | 8.0.0 | Added | + | 8.5.0 | Added the `manage-abac-admin-settings` granular permission requirement. | +--- /mnt/user-data/uploads/Rocket.Chat-Open-API/user-management.yaml 2026-09-08 19:37:19.090256801 +0000 ++++ patched-1539/user-management.yaml 2026-09-08 19:38:34.562255074 +0000 +@@ -520,7 +520,7 @@ + description: |- +
Premium tag
+ +- Update a role in the workspace.
++ Update a role in the workspace. + + Permission required: `access-permissions` + +@@ -646,7 +646,8 @@ + - Roles + summary: Assign Role to User + description: |- +- Assign a role to a user. Optionally, you can set this role to a user for a specific room.
++ Assign a role to a user. Optionally, you can set this role to a user for a specific room. ++ + **Permissions required**: + - `access-permissions`: Required to modify permissions for various roles + - `assign-admin-role`: Permission to assign the admin role to other users +@@ -1260,7 +1261,8 @@ + summary: Create User + description: |- + Create a new user in your workspace. This endpoint is typically used by admins to create user accounts in the workspace. +-
Permissions required: ++ ++ Permissions required: + - `create-user`: Permission to create users + - `edit-other-user-active-status`: Permission to enable or disable other accounts + +@@ -1580,7 +1582,8 @@ + - Users + summary: Update User Details + description: |- +- Use this endpoint to update the details of an existing user. This endpoint requires 2FA.
++ Use this endpoint to update the details of an existing user. This endpoint requires 2FA. ++ + **Permissions required**: + - `edit-other-user-password`: Permission to modify other user's passwords + - `edit-other-user-info_description`: Permission to change other user's name, username or email address +@@ -4080,7 +4083,8 @@ + success: false + error: The 'email' param is required + description: |- +- Send an email to reset your password. Ensure that you have completed the configuration of the email; otherwise, your users will not receive the mail normally. Access this from **Manage** > **Workspace** > **Settings** > **Email**.
++ Send an email to reset your password. Ensure that you have completed the configuration of the email; otherwise, your users will not receive the mail normally. Access this from **Manage** > **Workspace** > **Settings** > **Email**. ++ + To use this endpoint, the `PasswordReset` setting must be enabled in **Settings** > **Accounts** > **Registration** > **Password Reset**. + + ### Changelog +@@ -5250,7 +5254,7 @@ + description: |- +
Premium tag
+ +- Syncs your LDAP data based on the data sync configurations. This endpoints requires 2FA.
++ Syncs your LDAP data based on the data sync configurations. This endpoints requires 2FA. + + Make sure LDAP is enabled in **Settings** > **LDAP** > **Enable** before using this endpoint. + diff --git a/messaging.yaml b/messaging.yaml index 25b86ea..8b83f8d 100644 --- a/messaging.yaml +++ b/messaging.yaml @@ -2743,7 +2743,7 @@ paths: - Chat summary: Send Message description: |- - The difference between `chat.postMessage` and `chat.sendMessage` is that `chat.sendMessage` allows for passing a value for `_id` and the other one doesn't. Also, `chat.sendMessage` only sends it to one channel whereas the other one allows for sending to more than one channel at a time.
+ The difference between `chat.postMessage` and `chat.sendMessage` is that `chat.sendMessage` allows for passing a value for `_id` and the other one doesn't. Also, `chat.sendMessage` only sends it to one channel whereas the other one allows for sending to more than one channel at a time. **Note**: You can only send alias and avatar properties if your user has the `message-impersonate permission`. We implemented this rule to avoid users impersonating other users. By default, only the bot role has this permission, but that can be changed in **Manage** -> **Permissions** -> **message-impersonate**. diff --git a/omnichannel.yaml b/omnichannel.yaml index 98d8da1..e1b3111 100644 --- a/omnichannel.yaml +++ b/omnichannel.yaml @@ -4052,7 +4052,7 @@ paths: description: |-
Enterprise
- Set the priority of an Omnichannel room.
+ Set the priority of an Omnichannel room. Permission required: `view-l-room` @@ -4118,7 +4118,7 @@ paths: description: |-
Enterprise
- Remove the priority set to an Omnichannel room.
+ Remove the priority set to an Omnichannel room. Permission required: `view-l-room` @@ -7222,7 +7222,7 @@ paths: description: |-
Enterprise
- Request a PDF transcript for an Omnichannel conversation. The conversation must be closed before it can be exported.
+ Request a PDF transcript for an Omnichannel conversation. The conversation must be closed before it can be exported. Permission required: `request-pdf-transcript`. Omnichannel managers and agents have this permission by default. @@ -12082,7 +12082,8 @@ paths: description: |-
Enterprise
- Get details of a specific unit.
+ Get details of a specific unit. + Permission required: `manage-livechat-units` tags: - Omnichannel Units @@ -12148,7 +12149,8 @@ paths: description: |-
Enterprise
- Get the list of monitors associated with a specific unit.
+ Get the list of monitors associated with a specific unit. + Permission required: `manage-livechat-units` tags: - Omnichannel Units @@ -12416,7 +12418,7 @@ paths: description: |-
Enterprise
- View the metrics of omnichannel conversations in your workspace during a selected time range based on their status: **Open**, **Queued**, **On Hold**, or **Closed**.
+ View the metrics of omnichannel conversations in your workspace during a selected time range based on their status: **Open**, **Queued**, **On Hold**, or **Closed**. Permission required: `view-livechat-reports` @@ -12480,7 +12482,7 @@ paths:
Enterprise
- View the metrics of omnichannel conversations in your workspace during a selected time range based on their departments.
+ View the metrics of omnichannel conversations in your workspace during a selected time range based on their departments. Permission required: `view-livechat-reports` @@ -12545,7 +12547,7 @@ paths: description: |-
Enterprise
- View the metrics of omnichannel conversations in your workspace during a selected time range based on their tags.
+ View the metrics of omnichannel conversations in your workspace during a selected time range based on their tags. Permission required: `view-livechat-reports` @@ -12612,7 +12614,7 @@ paths:
Enterprise
- View the metrics of omnichannel conversations in your workspace during a selected time range based on the agents in your workspace.
+ View the metrics of omnichannel conversations in your workspace during a selected time range based on the agents in your workspace. Permission required: `view-livechat-reports` @@ -12931,7 +12933,8 @@ paths: description: |-
Enterprise
- Get details of a specific SLA policy.
+ Get details of a specific SLA policy. + At least one of the following permissions is required: * `manage-livechat-sla` * `view-l-room` @@ -12990,7 +12993,8 @@ paths:
Enterprise
- Update an existing SLA policy.
+ Update an existing SLA policy. + Permission required: `manage-livechat-sla` ### Changelog @@ -14571,7 +14575,7 @@ paths: description: |-
Enterprise
- Get a list of all canned responses in the workspace that belong to the current user scope.
+ Get a list of all canned responses in the workspace that belong to the current user scope. Permission required: `view-canned-responses` @@ -14666,7 +14670,7 @@ paths: description: |-
Enterprise
- Get a specific canned response.
+ Get a specific canned response. Permission required: `view-canned-responses` @@ -14756,7 +14760,7 @@ paths: Use this endpoint to delete a canned response. Permission required: `remove-canned-responses` ### Changelog - | Version | Description + | Version | Description | | ---------------- | ------------| |7.12.0 | Added | parameters: diff --git a/rooms.yaml b/rooms.yaml index f24aa27..adf4dab 100644 --- a/rooms.yaml +++ b/rooms.yaml @@ -14659,7 +14659,7 @@ paths: before they can join via an invite token. ### Changelog - | Version | Change | + | Version | Description | |---------|--------| | 8.4.0 | Added ban check — banned users can no longer join via invite token | operationId: post-useInviteToken @@ -16371,7 +16371,7 @@ paths: Permissions required: `abac-management` and `manage-abac-admin-settings`. ### Changelog - | Version | Change | + | Version | Description | |---------|--------| | 8.0.0 | Added | | 8.5.0 | Added the `manage-abac-admin-settings` granular permission requirement. | diff --git a/user-management.yaml b/user-management.yaml index 93b4aae..757fdec 100644 --- a/user-management.yaml +++ b/user-management.yaml @@ -520,7 +520,7 @@ paths: description: |-
Premium tag
- Update a role in the workspace.
+ Update a role in the workspace. Permission required: `access-permissions` @@ -646,7 +646,8 @@ paths: - Roles summary: Assign Role to User description: |- - Assign a role to a user. Optionally, you can set this role to a user for a specific room.
+ Assign a role to a user. Optionally, you can set this role to a user for a specific room. + **Permissions required**: - `access-permissions`: Required to modify permissions for various roles - `assign-admin-role`: Permission to assign the admin role to other users @@ -1260,7 +1261,8 @@ paths: summary: Create User description: |- Create a new user in your workspace. This endpoint is typically used by admins to create user accounts in the workspace. -
Permissions required: + + Permissions required: - `create-user`: Permission to create users - `edit-other-user-active-status`: Permission to enable or disable other accounts @@ -1580,7 +1582,8 @@ paths: - Users summary: Update User Details description: |- - Use this endpoint to update the details of an existing user. This endpoint requires 2FA.
+ Use this endpoint to update the details of an existing user. This endpoint requires 2FA. + **Permissions required**: - `edit-other-user-password`: Permission to modify other user's passwords - `edit-other-user-info_description`: Permission to change other user's name, username or email address @@ -4080,7 +4083,8 @@ paths: success: false error: The 'email' param is required description: |- - Send an email to reset your password. Ensure that you have completed the configuration of the email; otherwise, your users will not receive the mail normally. Access this from **Manage** > **Workspace** > **Settings** > **Email**.
+ Send an email to reset your password. Ensure that you have completed the configuration of the email; otherwise, your users will not receive the mail normally. Access this from **Manage** > **Workspace** > **Settings** > **Email**. + To use this endpoint, the `PasswordReset` setting must be enabled in **Settings** > **Accounts** > **Registration** > **Password Reset**. ### Changelog @@ -5250,7 +5254,7 @@ paths: description: |-
Premium tag
- Syncs your LDAP data based on the data sync configurations. This endpoints requires 2FA.
+ Syncs your LDAP data based on the data sync configurations. This endpoints requires 2FA. Make sure LDAP is enabled in **Settings** > **LDAP** > **Enable** before using this endpoint.