Skip to main content
POST
/
v1
/
chats
Create new chat
curl --request POST \
  --url https://api.example.com/v1/chats \
  --header 'Content-Type: application/json' \
  --data '
{
  "participants": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "metadata": {}
}
'
import requests

url = "https://api.example.com/v1/chats"

payload = {
"participants": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"metadata": {}
}
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({participants: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'], metadata: {}})
};

fetch('https://api.example.com/v1/chats', 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/v1/chats",
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([
'participants' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'metadata' => [

]
]),
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/v1/chats"

payload := strings.NewReader("{\n \"participants\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"metadata\": {}\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/v1/chats")
.header("Content-Type", "application/json")
.body("{\n \"participants\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"metadata\": {}\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/chats")

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 \"participants\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"metadata\": {}\n}"

response = http.request(request)
puts response.read_body
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "type": "<string>",
  "participants": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "lastMessage": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "chatId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "senderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "content": "<string>",
    "type": "<string>",
    "metadata": {},
    "createdAt": "2023-11-07T05:31:56Z",
    "readBy": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ]
  },
  "unreadCount": 123,
  "metadata": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Body

application/json
type
enum<string>
required
Available options:
direct,
group
participants
string<uuid>[]
required
metadata
object

Response

201 - application/json

Chat created successfully

id
string<uuid>
type
string
participants
string<uuid>[]
lastMessage
object
unreadCount
integer
metadata
object
createdAt
string<date-time>
updatedAt
string<date-time>