Skip to main content
POST
/
action
/
add_user_to_chat
Add user to chat
curl --request POST \
  --url https://api.livechatinc.com/v3.6/agent/action/add_user_to_chat \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "chat_id": "PW94SJTGW6",
  "user_id": "smith@example.com",
  "user_type": "agent",
  "visibility": "all",
  "ignore_requester_presence": true
}
'
import requests

url = "https://api.livechatinc.com/v3.6/agent/action/add_user_to_chat"

payload = {
"chat_id": "PW94SJTGW6",
"user_id": "smith@example.com",
"user_type": "agent",
"visibility": "all",
"ignore_requester_presence": True
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
chat_id: 'PW94SJTGW6',
user_id: 'smith@example.com',
user_type: 'agent',
visibility: 'all',
ignore_requester_presence: true
})
};

fetch('https://api.livechatinc.com/v3.6/agent/action/add_user_to_chat', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.livechatinc.com/v3.6/agent/action/add_user_to_chat",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'chat_id' => 'PW94SJTGW6',
'user_id' => 'smith@example.com',
'user_type' => 'agent',
'visibility' => 'all',
'ignore_requester_presence' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.livechatinc.com/v3.6/agent/action/add_user_to_chat"

payload := strings.NewReader("{\n \"chat_id\": \"PW94SJTGW6\",\n \"user_id\": \"smith@example.com\",\n \"user_type\": \"agent\",\n \"visibility\": \"all\",\n \"ignore_requester_presence\": true\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.livechatinc.com/v3.6/agent/action/add_user_to_chat")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"chat_id\": \"PW94SJTGW6\",\n \"user_id\": \"smith@example.com\",\n \"user_type\": \"agent\",\n \"visibility\": \"all\",\n \"ignore_requester_presence\": true\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.livechatinc.com/v3.6/agent/action/add_user_to_chat")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"chat_id\": \"PW94SJTGW6\",\n \"user_id\": \"smith@example.com\",\n \"user_type\": \"agent\",\n \"visibility\": \"all\",\n \"ignore_requester_presence\": true\n}"

response = http.request(request)
puts response.read_body
Required scopes: or

Authorizations

Authorization
string
header
required

Use your account ID as the username and your personal access token (PAT) as the password, or pass a Base64-encoded value directly in the Authorization header. For more information, see the personal access tokens guide.

Body

application/json
chat_id
string
required

The chat ID.

user_id
string
required

The user ID.

user_type
enum<string>
required

The user type.

Available options:
agent,
customer
visibility
enum<string>
required

Visibility of the user in the chat. customer must be added with all.

Available options:
all,
agents
ignore_requester_presence
boolean
default:false

If true: the requester doesn't need to be present on the list of chat users.

Response

200

User added to chat.