deprecated-endpoints.md

Deprecated Endpoints

The methods and endpoints of the Rest API and Realtime API that have been depreciated are listed below.

REST API

Endpoints to be removed

Endpoint	Release deprecated	Planned removal	Description
/users.createToken	6.8.0	8.0.0	The endpoint will be removed.
/licenses.get	6.5.0	7.0.0	The endpoint is replaced by /licenses.info
/licenses.isEnterprise	6.5.0	7.0.0	The endpoint is replaced by /licenses.info
/livechat/room.visitor	5.2.0	7.0.0	The endpoint will be removed.
/livechat/inquiries.queued	5.4.1	7.0.0	The endpoint is replaced by /livechat/inquiries.queuedForUser

Removed endpoints

The following endpoints have been removed:

Endpoint	Release deprecated	Release removed
/livechat/office-hours		5.0.0
/v1/info	1.0.0	1.12.0
/emoji.custom	1.0.0	1.12.0
/permissions.list	0.73.0	1.11.0
/permissions	0.66.0	0.69.0
/channels.cleanHistory	0.64.0	0.67.0
/user.roles	0.63.0	0.66.0

Renamed endpoints

The following endpoints have been replaced:

Endpoint	Renamed endpoint	Release
/livechat/business-hours.list	/livechat/business-hours	5.0.0
/livechat/departments.available-by-unit/:unitId	/livechat/units/:unitId/departments/available	5.0.0
/livechat/departments.by-unit/:unitId	/livechat/units/:unitId/departments	5.0.0
/livechat/monitors.list	/livechat/monitors	5.0.0
/livechat/units.getOne	/livechat/monitors/:username	5.0.0
/livechat/priorities.list	/livechat/priorities	5.0.0
/livechat/priority.getOne	/livechat/priorities/:priorityId	5.0.0
/livechat/tags.list	/livechat/tags	5.0.0
/livechat/tags.getOne	/livechat/tags/:tagId	5.0.0
/livechat/units.list	/livechat/units	5.0.0
/livechat/units.getOne	/livechat/units/:unitId	5.0.0
/livechat/unitMonitors.list	/livechat/units/:unitId/monitors	5.0.0

Changes in parameters

Parameter	Endpoints affected	Release deprecated	Planned removal	Description
query and fields query parameters	All endpoints	5.0.0	7.0.0	The parameters are removed to avoid malicious queries. Check the endpoints for alternatives.
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).

Realtime API

Method	Release deprecated	Removal
reportMessage	6.2.0	7.0.0
livechat:getDepartmentForwardRestrictions	5.2.0	7.0.0
livechat:getFirstRoomMessage	5.2.0	7.0.0
cleanChannelHistory	0.64.0	0.67.0
addOAuthApp	6.0.0	6.0.0
canAccessRoom	4.1.1	5.0.0

Replaced methods

Method	Release deprecated	Planned removal	Description
muteUserInRoom	6.8.0	8.0.0	Replaced by the /rooms.muteUser endpoint.
unmuteUserInRoom	6.8.0	8.0.0	Replaced by the /rooms.unmuteUser endpoint.
inserOrUpdateUser	6.7.0	8.0.0	Users upsert won't be allowed anymore (the method will be completely removed).
livechat:removeTrigger	6.5.0	7.0.0	Replaced by the /livechat/triggers/:_id (DELETE) endpoint.
livechat:discardTranscript	6.4.0	7.0.0	Replaced by the /livechat/transcript/:rid (DELETE) endpoint.
livechat:getAgentOverviewData	6.4.0	7.0.0	Replaced by the /livechat/analytics/agent-overview endpoint.
livechat:getAnalyticsOverviewData	6.4.0	7.0.0	Replaced by the /livechat/analytics/overview endpoint.
livechat:requestTranscript	6.4.0	7.0.0	Replaced by the /livechat/transcript/:rid endpoint.
livechat:saveAppearance	6.4.0	7.0.0	Replaced by the /livechat/appearance endpoint.
livechat:saveTrigger	6.4.0	7.0.0	Replaced by the /livechat/triggers endpoint.
livechat:getAgentData	6.4.0	7.0.0	Replaced by the /livechat/agent.info/:rid/:token endpoint.
livechat:resumeOnHold	6.3.0	7.0.0	Replaced by the /livechat/room.resumeOnHold endpoint.
deleteMessage	6.2.0	7.0.0	Replaced by chat.delete endpoint.
livechat:saveIntegration	6.2.0	7.0.0	Replaced by the /omnichannel/integrations (POST) endpoint.
addOauthApp	6.2.0	7.0.0	Replaced by the oauth-apps.create endpoint.
livechat:closeRoom	6.0.0	7.0.0	Replaced by the /livechat/room.close or /livechat/room.closeByUser endpoints.
listEmojiCustom	5.4.3	7.0.0	Replaced by emoji-custom.list endpoint.
getAvatarSuggestion	5.4.0	7.0.0	Replaced by the users.getAvatarSuggestion endpoint.
refreshClients	5.4.0	7.0.0	This is now triggered by assets.setAsset and assets.unsetAsset.
eraseRoom	5.4.0	7.0.0	Replaced by rooms.delete endpoint.
checkUsernameAvailability	5.4.0	7.0.0	Replaced by users.checkUsernameAvailability endpoint.
Mailer:unsubscribe	5.4.0	7.0.0	Replaced by the mailer.unsubscribe endpoint.
Mailer.sendMail	5.4.0	7.0.0	Replaced by the mailer endpoint.
sendConfirmationEmail	5.4.0	7.0.0	Replaced by users.sendConfirmationEmail endpoint.
livechat:changeLivechatStatus	5.4.0	7.0.0	Replaced by the /livechat/agent.status endpoint.
livechat:webhookTest	5.4.0	7.0.0	Replaced by the /livechat/webhook.test endpoint.
livechat:saveInfo	5.3.0	7.0.0	Replaced by the /livechat/room/save.info endpoint.
livechat:addAgent	5.2.0	7.0.0	Replaced by the /livechat/agent endpoint.
livechat:addManager	5.2.0	7.0.0	Replaced by /livechat/manager endpoint.
livechat:getCustomFields	5.2.0	7.0.0	Replaced by the /livechat/custom-fields endpoint.
livechat:getNextAgent	5.2.0	7.0.0	Replaced by the /livechat/agent.next/:token endpoint.
livechat:getTagsList	5.2.0	7.0.0	Replaced by the /livechat/tags endpoint.
livechat:loadHistory	5.2.0	7.0.0	Replaced by the /livechat/messages.history/:rid endpoint.
livechat:loginByToken	5.2.0	7.0.0	Replaced by th /livechat/visitor/:token endpoint.
livechat:pageVisited	5.2.0	7.0.0	Replaced by the /livechat/page.visited endpoint.
livechat:registerGuest	5.2.0	7.0.0	Replaced by the /livechat/visitor endpoint.
livechat:removeAgent	5.2.0	7.0.0	Replaced by the /livechat/users/agent/:_id endpoint.
livechat:removeDepartment	5.2.0	7.0.0	Replaced by the /livechat/department/:_id endpoint.
livechat:removeManager	5.2.0	7.0.0	Replaced by the /livechat/users/manager/:_id endpoint.
livechat:saveDepartmentAgents	5.2.0	7.0.0	Replaced by the /livechat/department/:_id/agents endpoint.
livechat:saveSurveyFeedback	5.2.0	7.0.0	Replaced by the /livechat/room.survey endpoint.
livechat:searchAgent	5.2.0	7.0.0	Replaced by the /livechat/users/agent/:_id endpoint.
livechat:sendOfflineMessage	5.2.0	7.0.0	Replaced by the /livechat/offline.message endpoint.
livechat:setCustomField	5.2.0	7.0.0	Replaced by the /livechat/visitor endpoint.
livechat:setDepartmentForVisitor	5.2.0	7.0.0	Replaced by the /livechat/visitor endpoint.
livechat:transfer	5.2.0	7.0.0	Replaced by the /livechat/room.forward endpoint.
roomNameExists	5.1.0	7.0.0	Replaced by rooms.nameExists endpoint.
removeWebdavAccount	5.1.0	7.0.0	Replaced by webdav.removeWebdavAccount endpoint.
getPasswordPolicy	5.1.0	7.0.0	Replaced by the pw.getPolicy endpoint.

Changes in parameters

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).