Deprecated Parameters

Print
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

This document covers the parameters deprecated in Rocket.Chat’s REST API endpoints and Realtime API methods. These parameters will be removed in future releases, and alternatives should be adopted to ensure continued functionality.

REST API

The table below shows the deprecated parameters in our REST API endpoints:

Parameter	Endpoints affected	Release deprecated	Planned removal	Description
`role`	roles.getUsersInRole	4.6.0	7.0.0	The parameter will stop being interpreted as the role name as a fallback (enter the role ID instead).
`roleName`	roles.addUserToRole	4.6.0	7.0.0	The parameter will stop being accepted (use the `roleId` parameter instead).
`roleName`	roles.removeUserFromRole	4.6.0	7.0.0	The parameter will stop being accepted (use the `roleId` parameter instead).
`appId`	oauth-apps.get	6.0.0	7.0.0	The parameter will stop being accepted (use the `clientId` or `_id` parameters instead).

Query and fields query parameters

As of version 5.0.0, the query and fields query parameters have been deprecated across all endpoints that previously supported them, with planned removal in version 7.0.0. This deprecation aims to prevent malicious queries. The following endpoints are among those affected:

Endpoint	`query` parameter	`fields` parameter
settings.public	✓	✓
statistics.list	✓	✓
custom-sounds.list	✓	✓
emoji-custom.list	✓	x
integrations.history	✓	✓
integrations.list	✓	✓
users.list	✓	✓
users.info	x	✓
chat.getThreadsList	✓	✓
chat.getThreadMessages	✓	✓
im.files	✓	✓
im.list.everyone	✓	✓
im.messages	✓	✓
im.messages.others	✓	✓
email-inbox.list	✓	✓
spotlight	✓	x
omnichannel/agents/available	✓	x
livechat/rooms (GET)	x	✓
canned-responses (GET)	x	✓
voip/rooms	x	✓
channels.anonymousread	✓	✓
channels.files	✓	✓
channels.list.joined	✓	✓
channels.list	✓	✓
channels.messages	✓	x
channels.getIntegrations	✓	✓
rooms.getDiscussions	✓	✓
teams.list	✓	x
groups.online	✓	x
groups.getIntegrations	✓	✓
groups.listAll	✓	✓
groups.messages	✓	✓
groups.files	✓	✓
channels.online	✓	x
directory	✓	✓
rooms.info	x	✓

Realtime API

The table below outlines the deprecated parameters in our Realtime API methods:

Method	Parameters affected	Release deprecated	Planned removal	Description
`apps (POST)`	`downloadOnly`	6.6.0	7.0.0	The parameter will stop being accepted.
`authorization:removeUserFromRole`	`roleId`	4.6.0	7.0.0	The parameter will stop being interpreted as the role name as a fallback (use the role ID instead).
`authorization:deleteRole`	`roleId`	4.6.0	7.0.0	The parameter will stop being interpreted as the role name as a fallback (use the role ID instead).
`authorization:addUserToRole`	`roleId`	4.6.0	7.0.0	The parameter will stop being interpreted as the role name as a fallback (use the role ID instead).

Was this article helpful?

What's Next

Testing Fuselage Components

On this page