Create a conversation
curl --request POST \
--url https://api.example.com/conversations/create \
--header 'Content-Type: application/json' \
--data '
{
"recipients": [
123
]
}
'import requests
url = "https://api.example.com/conversations/create"
payload = { "recipients": [123] }
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({recipients: [123]})
};
fetch('https://api.example.com/conversations/create', 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.example.com/conversations/create",
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([
'recipients' => [
123
]
]),
CURLOPT_HTTPHEADER => [
"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.example.com/conversations/create"
payload := strings.NewReader("{\n \"recipients\": [\n 123\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
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.example.com/conversations/create")
.header("Content-Type", "application/json")
.body("{\n \"recipients\": [\n 123\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/conversations/create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"recipients\": [\n 123\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": 1,
"type": "direct",
"title": "",
"created_at": 123,
"updated_at": 123,
"latest_message": {},
"mute_rule": 123,
"unread_message_count": 0,
"participants": [
{
"id": 1,
"first_name": "John",
"last_name": "Doe",
"name": "John Doe",
"title": "Manager",
"active": true,
"avatar": {},
"archived_at": 123,
"participant_type": "<string>",
"subtext": "Manager - HQ (Sales)",
"department": {
"id": 10,
"name": "Sales"
},
"unit": {
"id": 5,
"name": "HQ"
}
}
],
"publish": {
"created_at": 123,
"updated_at": 123
},
"archived_at": 123
}Conversations
Create a conversation
Creates a new conversation or returns an existing one with the given recipients. For a single recipient, finds or creates a direct conversation. For multiple recipients, creates a group conversation.
POST
/
conversations
/
create
Create a conversation
curl --request POST \
--url https://api.example.com/conversations/create \
--header 'Content-Type: application/json' \
--data '
{
"recipients": [
123
]
}
'import requests
url = "https://api.example.com/conversations/create"
payload = { "recipients": [123] }
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({recipients: [123]})
};
fetch('https://api.example.com/conversations/create', 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.example.com/conversations/create",
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([
'recipients' => [
123
]
]),
CURLOPT_HTTPHEADER => [
"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.example.com/conversations/create"
payload := strings.NewReader("{\n \"recipients\": [\n 123\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
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.example.com/conversations/create")
.header("Content-Type", "application/json")
.body("{\n \"recipients\": [\n 123\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/conversations/create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"recipients\": [\n 123\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": 1,
"type": "direct",
"title": "",
"created_at": 123,
"updated_at": 123,
"latest_message": {},
"mute_rule": 123,
"unread_message_count": 0,
"participants": [
{
"id": 1,
"first_name": "John",
"last_name": "Doe",
"name": "John Doe",
"title": "Manager",
"active": true,
"avatar": {},
"archived_at": 123,
"participant_type": "<string>",
"subtext": "Manager - HQ (Sales)",
"department": {
"id": 10,
"name": "Sales"
},
"unit": {
"id": 5,
"name": "HQ"
}
}
],
"publish": {
"created_at": 123,
"updated_at": 123
},
"archived_at": 123
}Body
application/json
User IDs of conversation participants
Response
200 - application/json
The created or existing conversation.
Example:
1
Conversation type: direct or group
Example:
"direct"
Conversation title (group only)
Example:
""
Unix timestamp
Unix timestamp
Latest message in the conversation
Mute rule ID or null
Example:
0
Conversation participants
Show child attributes
Show child attributes
Show child attributes
Show child attributes
When the auth user archived this conversation
⌘I