Skip to main content
POST
/
conversations
/
{conversation}
/
messages
Create a new message in a conversation
curl --request POST \
  --url https://api.example.com/conversations/{conversation}/messages \
  --header 'Content-Type: application/json' \
  --data '
{
  "message": "<string>",
  "parent_id": 123
}
'
import requests

url = "https://api.example.com/conversations/{conversation}/messages"

payload = {
"message": "<string>",
"parent_id": 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({message: '<string>', parent_id: 123})
};

fetch('https://api.example.com/conversations/{conversation}/messages', 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/{conversation}/messages",
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([
'message' => '<string>',
'parent_id' => 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/{conversation}/messages"

payload := strings.NewReader("{\n \"message\": \"<string>\",\n \"parent_id\": 123\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/{conversation}/messages")
.header("Content-Type", "application/json")
.body("{\n \"message\": \"<string>\",\n \"parent_id\": 123\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/conversations/{conversation}/messages")

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 \"message\": \"<string>\",\n \"parent_id\": 123\n}"

response = http.request(request)
puts response.read_body
{
  "id": 1,
  "type": "<string>",
  "conversationId": 123,
  "is_reply": true,
  "parent": null,
  "deleted": true,
  "message": "<string>",
  "date": 123,
  "edited_at": 123,
  "reactions": [
    {}
  ],
  "author": {
    "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"
    }
  },
  "files": [
    {
      "id": 1,
      "name": "document.pdf",
      "mime": "application/pdf",
      "size": 102400,
      "type": "file",
      "extension": "pdf",
      "uploaded": true,
      "processing": false,
      "height": 123,
      "width": 123,
      "source": "<string>",
      "stream": "<string>",
      "versions": {},
      "screenshot": "<unknown>",
      "date": 123,
      "created_at": 123,
      "updated_at": 123,
      "created_formatted": "<string>",
      "updated_formatted": "<string>"
    }
  ],
  "voice": {
    "id": 1,
    "processing": true,
    "extension": "mp3",
    "duration": 12.5,
    "url": "<string>"
  }
}

Path Parameters

conversation
integer
required

Conversation ID

Body

application/json
message
string
required

Message text, may contain rich content markup

parent_id
integer | null

ID of the parent message when replying

Response

The created message.

id
integer
Example:

1

type
string
conversationId
integer
is_reply
boolean
parent
unknown
deleted
boolean
message
string
date
integer

Unix timestamp

edited_at
integer | null
reactions
object[]
author
object | null
files
object[]
voice
object | null