Deprecated Endpoints

Prev Next

The following methods and endpoints of the REST API and Realtime API have been deprecated. According to the version listed, they have either been replaced, removed, or are scheduled for removal.

REST API

Endpoint

Release deprecated

Release removed

Description

/apps (GET)

8.0.0

The GET /apps endpoint will be removed. Use the following endpoints instead:

  • /apps/marketplace to list apps.

  • /apps/categories to list categories.

  • /apps/buildExternalUrl to retrieve modal URLs.

  • /apps/installed to list installed apps.

banners.getNew

6.10.0

8.0.0

Use the /banners/:id or /banners endpoint.

rooms.upload/:rid

6.10.0

8.0.0

Replaced by the /rooms.media/:rid endpoint.

/users.createToken

6.8.0

8.0.0

The endpoint will be removed.

insertOrUpdateUser

6.7.0

8.0.0

Users’ upsert is no longer allowed. Replaced by /users.create endpoint.

channels.images

6.8.0

7.0.0

The endpoint is replaced. rooms.images

pw.getPolicyReset

6.3.0

7.0.0

The endpoint is replaced pw.getPolicy

/livechat/inquiries.queued

5.4.1

7.0.0

The endpoint is replaced by /livechat/inquiries.queuedForUser

/livechat/room.transfer

5.1.0

7.0.0

The endpoint is replaced by /livechat/room.forward

/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/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

Realtime API

The following methods are no longer supported:

Method

Release deprecated

Release removal

livechat:setUpConnection

7.11.0

8.0.0

livechat:getUnitsFromUser

7.4.0

8.0.0

livechat:getDepartmentForwardRestrictions

5.2.0

8.0.0

livechat:getFirstRoomMessage

5.2.0

8.0.0

reportMessage

6.2.0

7.0.0 - Use the chat.reportMessage endpoint instead.

cleanChannelHistory

0.64.0

0.67.0

canAccessRoom

4.1.1

5.0.0

Replaced methods

The following methods are deprecated; use the corresponding API endpoints instead:

Method

Release deprecated

Release removal

Description

livechat:saveBusinessHour

7.14.0

8.0.0

Replaced by the /livechat/business-hours.save endpoint.

livechat:addMonitor

7.14.0

8.0.0

Replaced by /livechat/monitors endpoint.

livechat:removeBusinessHour

7.14.0

8.0.0

Replaced by the /livechat/business-hours.remove endpoint.

livechat:saveTag

7.14.0

8.0.0

Replaced by the /livechat/monitors.delete endpoint.

livechat:saveUnit

7.13.0

8.0.0

Replaced by the livechat/units endpoint.

saveCannedResponses

7.12.0

8.0.0

Replaced by the /canned-responses endpoint.

livechat:removeTag

7.12.0

8.0.0

Replaced by the livechat/tags.remove endpoint.

sendFileLivechatMessage

7.12.0

8.0.0

Replaced by the livechat/upload/:rid endpoint.

livechat:returnAsInquiry

7.12.0

8.0.0

Replaced by the livechat/inquiries.returnAsInquiry endpoint.

livechat:removeRoom

7.12.0

8.0.0

Replaced by the livechat/rooms.delete endpoint.

removeCannedResponse

7.12.0

8.0.0

Replaced by the /v1/canned-responses/:_id endpoint.

livechat:removeUnit

7.12.0

8.0.0

Replaced by the livechat/units/{id} endpoint.

setAdminStatus

7.11.0

8.0.0

Use the /roles.addUserToRole or /roles.removeUserFromRole endpoint.

livechat:takeInquiry

7.11.0

8.0.0

Replaced by the livechat/inquiries.take endpoint.

livechat:saveDepartment

7.11.0

8.0.0

Replaced by the livechat/department endpoint.

livechat:sendTranscript

7.11.0

8.0.0

Replaced by the livechat/transcript endpoint.

livechat:saveCustomField

7.11.0

8.0.0

Replaced by the livechat/custom-fields.save endpoint.

livechat:removeAllClosedRooms

7.11.0

8.0.0

Replaced by the livechat/rooms.removeAllClosedRooms endpoint.

livechat:removeRoom

7.11.0

8.0.0

Replaced by the livechat/inquiries.take endpoint.

livechat:getRoutingConfig

7.11.0

8.0.0

Replaced by the livechat/config/routing endpoint.

livechat:getAnalyticsChartData

7.11.0

8.0.0

Replaced by the livechat/analytics/dashboards/charts-data endpoint.

livechat:saveAgentInfo

7.11.0

8.0.0

Replaced by the livechat/agents.saveInfo endpoint.

livechat:removeCustomField

7.11.0

8.0.0

Replaced by the livechat/custom-fields.delete endpoint.

authorization:addUserToRole

7.10.0

8.0.0

Replaced by the /roles.addUserToRole endpoint.

authorization:deleteRole

7.10.0

8.0.0

Replaced by the /roles.delete endpoint.

authorization:removeUserFromRole

7.10.0

8.0.0

Replaced by the /roles.removeUserFromRole endpoint.

getRoomRoles

7.10.0

8.0.0

Replaced by the /rooms.roles endpoint.

getUserRoles

7.10.0

8.0.0

Replaced by the /roles.getUsersInPublicRoles endpoint.

saveCustomFields

7.10.0

8.0.0

Replaced by the /users.updateOwnBasicInfo endpoint.

setUsername

7.10.0

8.0.0

Replaced by the /users.updateOwnBasicInfo endpoint.

setReaction

7.10.0

8.0.0

Replaced by the /chat.react endpoint.

saveUserProfile

7.10.0

8.0.0

Replaced by the /users.updateOwnBasicInfo endpoint.

setUserPassword

7.10.0

8.0.0

Replaced by the /users.updateOwnBasicInfo endpoint.

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

createToken

6.8.0

8.0.0

This method will be removed.

livechat:resumeOnHold

6.3.0

8.0.0

Replaced by the /livechat/room.resumeOnHold endpoint.

livechat:closeRoom

6.0.0

8.0.0

Replaced by the /livechat/room.close endpoint.

getAvatarSuggestion

5.4.0

8.0.0

Replaced by the users.getAvatarSuggestion endpoint.

sendConfirmationEmail

5.4.0

8.0.0

Replaced by users.sendConfirmationEmail endpoint.

livechat:changeLivechatStatus

5.4.0

8.0.0

Replaced by the /livechat/agent.status endpoint.

livechat:getTagsList

5.2.0

8.0.0

Replaced by the /livechat/tags endpoint.

livechat:transfer

5.2.0

8.0.0

Replaced by the /livechat/room.forward endpoint.

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.

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.

listEmojiCustom

5.4.3

7.0.0

Replaced by emoji-custom.list 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.

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/users/agent (POST) endpoint .

livechat:addManager

5.2.0

7.0.0

Replaced by livechat/users/manager (POST) 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: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.

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.