Product DocsSchemaAuthentication

Chat

Gets a list of chat config

get

This endpoint is used to fetch the chat config in the current organization

Authorizations
Responses
200

No response body

No content
get
/ux/common/live_chat/chat/
GET /ux/common/live_chat/chat/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

No response body

No content

Updates the chat config

post

This endpoint is used to update the chat config for the current organization

Authorizations
Responses
201

No response body

No content
post
/ux/common/live_chat/chat/
POST /ux/common/live_chat/chat/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
201

No response body

No content
get

Live Chat API endpoints

Authorizations
Path parameters
idstringRequired
Responses
200

No response body

No content
get
/ux/common/live_chat/chat/{id}/
GET /ux/common/live_chat/chat/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

No response body

No content
put

Live Chat API endpoints

Authorizations
Path parameters
idstringRequired
Responses
200

No response body

No content
put
/ux/common/live_chat/chat/{id}/
PUT /ux/common/live_chat/chat/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

No response body

No content
delete

Live Chat API endpoints

Authorizations
Path parameters
idstringRequired
Responses
204

No response body

No content
delete
/ux/common/live_chat/chat/{id}/
DELETE /ux/common/live_chat/chat/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
204

No response body

No content
post

Live Chat API endpoints

Authorizations
Responses
200

No response body

No content
post
/ux/common/live_chat/chat/chat_status/
POST /ux/common/live_chat/chat/chat_status/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

No response body

No content
post

Live Chat API endpoints

Authorizations
Responses
200

No response body

No content
post
/ux/common/live_chat/chat/chats/
POST /ux/common/live_chat/chat/chats/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

No response body

No content
get

Live Chat API endpoints

Authorizations
Responses
200

No response body

No content
get
/ux/common/live_chat/chat/messages/
GET /ux/common/live_chat/chat/messages/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

No response body

No content

Gets a list of chat config options

get

This endpoint is used to fetch all the option for chat config in the current organization

Authorizations
Responses
200

No response body

No content
get
/ux/common/live_chat/chat/options/
GET /ux/common/live_chat/chat/options/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

No response body

No content
post

Live Chat API endpoints

Authorizations
Responses
200

No response body

No content
post
/ux/common/live_chat/chat/start_chat/
POST /ux/common/live_chat/chat/start_chat/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

No response body

No content
PreviousLeavesNextMarketplace