Create a chat session
curl --request POST \
--url http://localhost:8080/chat/sessions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"channel": {
"type": "api"
},
"verified": true,
"custom_data": {},
"contact": {
"email": "[email protected]",
"name": "<string>",
"phone_number": "<string>",
"custom_data": {}
}
}
'import requests
url = "http://localhost:8080/chat/sessions"
payload = {
"contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"channel": { "type": "api" },
"verified": True,
"custom_data": {},
"contact": {
"email": "[email protected]",
"name": "<string>",
"phone_number": "<string>",
"custom_data": {}
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
contact_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
channel: {type: 'api'},
verified: true,
custom_data: {},
contact: {
email: '[email protected]',
name: '<string>',
phone_number: '<string>',
custom_data: {}
}
})
};
fetch('http://localhost:8080/chat/sessions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/chat/sessions",
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([
'contact_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'channel' => [
'type' => 'api'
],
'verified' => true,
'custom_data' => [
],
'contact' => [
'email' => '[email protected]',
'name' => '<string>',
'phone_number' => '<string>',
'custom_data' => [
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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 := "http://localhost:8080/chat/sessions"
payload := strings.NewReader("{\n \"contact_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"channel\": {\n \"type\": \"api\"\n },\n \"verified\": true,\n \"custom_data\": {},\n \"contact\": {\n \"email\": \"[email protected]\",\n \"name\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"custom_data\": {}\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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("http://localhost:8080/chat/sessions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"contact_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"channel\": {\n \"type\": \"api\"\n },\n \"verified\": true,\n \"custom_data\": {},\n \"contact\": {\n \"email\": \"[email protected]\",\n \"name\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"custom_data\": {}\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/chat/sessions")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"contact_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"channel\": {\n \"type\": \"api\"\n },\n \"verified\": true,\n \"custom_data\": {},\n \"contact\": {\n \"email\": \"[email protected]\",\n \"name\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"custom_data\": {}\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"statusCode": 123,
"message": "<string>",
"error": "<string>"
}Sessions
Create a chat session
Create a chat session — Creates a new chat session for the organization. Use when orchestrating conversations from code — creating sessions, sending messages, or listing history…
POST
/
chat
/
sessions
Create a chat session
curl --request POST \
--url http://localhost:8080/chat/sessions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"channel": {
"type": "api"
},
"verified": true,
"custom_data": {},
"contact": {
"email": "[email protected]",
"name": "<string>",
"phone_number": "<string>",
"custom_data": {}
}
}
'import requests
url = "http://localhost:8080/chat/sessions"
payload = {
"contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"channel": { "type": "api" },
"verified": True,
"custom_data": {},
"contact": {
"email": "[email protected]",
"name": "<string>",
"phone_number": "<string>",
"custom_data": {}
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
contact_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
channel: {type: 'api'},
verified: true,
custom_data: {},
contact: {
email: '[email protected]',
name: '<string>',
phone_number: '<string>',
custom_data: {}
}
})
};
fetch('http://localhost:8080/chat/sessions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/chat/sessions",
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([
'contact_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'channel' => [
'type' => 'api'
],
'verified' => true,
'custom_data' => [
],
'contact' => [
'email' => '[email protected]',
'name' => '<string>',
'phone_number' => '<string>',
'custom_data' => [
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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 := "http://localhost:8080/chat/sessions"
payload := strings.NewReader("{\n \"contact_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"channel\": {\n \"type\": \"api\"\n },\n \"verified\": true,\n \"custom_data\": {},\n \"contact\": {\n \"email\": \"[email protected]\",\n \"name\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"custom_data\": {}\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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("http://localhost:8080/chat/sessions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"contact_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"channel\": {\n \"type\": \"api\"\n },\n \"verified\": true,\n \"custom_data\": {},\n \"contact\": {\n \"email\": \"[email protected]\",\n \"name\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"custom_data\": {}\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/chat/sessions")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"contact_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"channel\": {\n \"type\": \"api\"\n },\n \"verified\": true,\n \"custom_data\": {},\n \"contact\": {\n \"email\": \"[email protected]\",\n \"name\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"custom_data\": {}\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"statusCode": 123,
"message": "<string>",
"error": "<string>"
}Custom data
Pass top-levelcustom_data to store session-level attributes on the new chat session, such as an order ID, cart value, or routing flag. Values can be strings, numbers, or booleans, and are returned by Get Session.
{
"channel": { "type": "api" },
"custom_data": { "order_id": "ord_123", "cart_value": 149.99, "priority": "high" }
}
400. To attach contact-level attributes instead, use contact.custom_data on Send Message.
Session
custom_data set through this endpoint is stored on the session but is not synced to a connected external ticketing system (e.g. Intercom or HubSpot).Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Show child attributes
Show child attributes
Session-level custom data to store on the chat session.
Show child attributes
Show child attributes
Contact to associate with the session. When provided (and no contact_id is given) a contact is created/updated and linked to the session; its custom_data is persisted on the contact. Honors the top-level verified flag — verified contacts write to custom_data, otherwise to non_verified_custom_data.
Show child attributes
Show child attributes
Response
Default Response
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Was this page helpful?