Deprecated Parameters

This article outlines the parameters deprecated in Rocket.Chat’s REST API endpoints and Realtime API methods. Some of these parameters have already been removed, while others are scheduled for removal in upcoming releases. To ensure continued functionality, adopt the recommended alternatives specified for each affected parameter.

REST API

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

API parameter removals in v9.0.0: The following parameters have been removed from their API endpoints:

Name	Parameter affected	Description	Deprecated since	Removed in version
livechat/department.autocomplete and livechat/visitors.autocomplete	`conditions` in `selector`	The field is no longer accepted.	8.8.0	9.0.0
users.info, users.create, and users.update	`freeSwitchExtension`	Renamed to `sipExtension`, also in user objects returned by the API.	-	9.0.0
channels.online and groups.online	`query`	The `_id` parameter is now required.	5.0.0	9.0.0
integrations.create and integrations.update	`skipTranspile`	Removed. Scripts are stored and run as written, without Babel.	-	9.0.0
All endpoints that accepted them	`query` and `fields`	Removed with the `ALLOW_UNSAFE_QUERY_AND_FIELDS_API_PARAMS` environment variable. See Query and fields query parameters.	5.0.0	9.0.0

API parameter removals: The following parameters have been permanently removed from their respective API endpoints in v8.0.0:

Name	Parameter affected	Description	Deprecated since	Removed in version
engagement-dashboard/channels/list	`hideRoomsWithNoActivity`	The endpoint no longer accepts `hideRoomsWithNoActivity` parameter. By default, inactive rooms will be excluded from the response.	6.11.0	8.0.0
oauth-apps.get	`appId`	This parameter will no longer be accepted (use clientId or _id instead).	6.0.0	8.0.0
roles.getUsersInRole	`role`	The role parameter will still be used, but its value must now always be the role ID. Querying with the role name as value is deprecated.	4.6.0	8.0.0
roles.addUserToRole	`roleName`	This parameter will no longer be accepted. Use `roleId` instead.	4.6.0	8.0.0
roles.removeUserFromRole	`roleName`	This parameter will no longer be accepted. Use `roleId` instead.	4.6.0	8.0.0

Query and fields query parameters

The query and fields parameters, deprecated since version 5.0.0 and disabled by default since 7.0.0, were removed in version 9.0.0, together with the ALLOW_UNSAFE_QUERY_AND_FIELDS_API_PARAMS environment variable. Use the filter parameters of each endpoint instead.

The following endpoints were 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	✓
dm.messages	✓	✓
custom-user-status.list	✓	x