Send a note message
curl --request POST \
--url http://localhost:3000/v2/chat/v2/{id}/sendNote \
--header 'Content-Type: application/json' \
--header 'x-API-Key: <api-key>' \
--data '
{
"_id": "<string>",
"number": 123,
"companyId": "<string>",
"status": {
"status": 123,
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"lastModifiedAt": "2023-11-07T05:31:56Z",
"lastModifiedBy": "<string>"
},
"chatId": "<string>",
"blocks": [
{}
],
"childMessageIds": [
"<string>"
],
"readByUserIds": [
"<string>"
],
"metadata": {
"type": "<string>",
"subId": "<string>",
"date": "2023-11-07T05:31:56Z",
"initialTab": "<string>"
},
"accessLevel": {
"_id": "<string>",
"level": 123,
"name": "<string>"
}
}
'import requests
url = "http://localhost:3000/v2/chat/v2/{id}/sendNote"
payload = {
"_id": "<string>",
"number": 123,
"companyId": "<string>",
"status": {
"status": 123,
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"lastModifiedAt": "2023-11-07T05:31:56Z",
"lastModifiedBy": "<string>"
},
"chatId": "<string>",
"blocks": [{}],
"childMessageIds": ["<string>"],
"readByUserIds": ["<string>"],
"metadata": {
"type": "<string>",
"subId": "<string>",
"date": "2023-11-07T05:31:56Z",
"initialTab": "<string>"
},
"accessLevel": {
"_id": "<string>",
"level": 123,
"name": "<string>"
}
}
headers = {
"x-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
_id: '<string>',
number: 123,
companyId: '<string>',
status: {
status: 123,
createdAt: '2023-11-07T05:31:56Z',
createdBy: '<string>',
lastModifiedAt: '2023-11-07T05:31:56Z',
lastModifiedBy: '<string>'
},
chatId: '<string>',
blocks: [{}],
childMessageIds: ['<string>'],
readByUserIds: ['<string>'],
metadata: {
type: '<string>',
subId: '<string>',
date: '2023-11-07T05:31:56Z',
initialTab: '<string>'
},
accessLevel: {_id: '<string>', level: 123, name: '<string>'}
})
};
fetch('http://localhost:3000/v2/chat/v2/{id}/sendNote', 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 => "3000",
CURLOPT_URL => "http://localhost:3000/v2/chat/v2/{id}/sendNote",
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([
'_id' => '<string>',
'number' => 123,
'companyId' => '<string>',
'status' => [
'status' => 123,
'createdAt' => '2023-11-07T05:31:56Z',
'createdBy' => '<string>',
'lastModifiedAt' => '2023-11-07T05:31:56Z',
'lastModifiedBy' => '<string>'
],
'chatId' => '<string>',
'blocks' => [
[
]
],
'childMessageIds' => [
'<string>'
],
'readByUserIds' => [
'<string>'
],
'metadata' => [
'type' => '<string>',
'subId' => '<string>',
'date' => '2023-11-07T05:31:56Z',
'initialTab' => '<string>'
],
'accessLevel' => [
'_id' => '<string>',
'level' => 123,
'name' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-API-Key: <api-key>"
],
]);
$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:3000/v2/chat/v2/{id}/sendNote"
payload := strings.NewReader("{\n \"_id\": \"<string>\",\n \"number\": 123,\n \"companyId\": \"<string>\",\n \"status\": {\n \"status\": 123,\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"createdBy\": \"<string>\",\n \"lastModifiedAt\": \"2023-11-07T05:31:56Z\",\n \"lastModifiedBy\": \"<string>\"\n },\n \"chatId\": \"<string>\",\n \"blocks\": [\n {}\n ],\n \"childMessageIds\": [\n \"<string>\"\n ],\n \"readByUserIds\": [\n \"<string>\"\n ],\n \"metadata\": {\n \"type\": \"<string>\",\n \"subId\": \"<string>\",\n \"date\": \"2023-11-07T05:31:56Z\",\n \"initialTab\": \"<string>\"\n },\n \"accessLevel\": {\n \"_id\": \"<string>\",\n \"level\": 123,\n \"name\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-API-Key", "<api-key>")
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:3000/v2/chat/v2/{id}/sendNote")
.header("x-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"_id\": \"<string>\",\n \"number\": 123,\n \"companyId\": \"<string>\",\n \"status\": {\n \"status\": 123,\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"createdBy\": \"<string>\",\n \"lastModifiedAt\": \"2023-11-07T05:31:56Z\",\n \"lastModifiedBy\": \"<string>\"\n },\n \"chatId\": \"<string>\",\n \"blocks\": [\n {}\n ],\n \"childMessageIds\": [\n \"<string>\"\n ],\n \"readByUserIds\": [\n \"<string>\"\n ],\n \"metadata\": {\n \"type\": \"<string>\",\n \"subId\": \"<string>\",\n \"date\": \"2023-11-07T05:31:56Z\",\n \"initialTab\": \"<string>\"\n },\n \"accessLevel\": {\n \"_id\": \"<string>\",\n \"level\": 123,\n \"name\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/v2/chat/v2/{id}/sendNote")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["x-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"_id\": \"<string>\",\n \"number\": 123,\n \"companyId\": \"<string>\",\n \"status\": {\n \"status\": 123,\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"createdBy\": \"<string>\",\n \"lastModifiedAt\": \"2023-11-07T05:31:56Z\",\n \"lastModifiedBy\": \"<string>\"\n },\n \"chatId\": \"<string>\",\n \"blocks\": [\n {}\n ],\n \"childMessageIds\": [\n \"<string>\"\n ],\n \"readByUserIds\": [\n \"<string>\"\n ],\n \"metadata\": {\n \"type\": \"<string>\",\n \"subId\": \"<string>\",\n \"date\": \"2023-11-07T05:31:56Z\",\n \"initialTab\": \"<string>\"\n },\n \"accessLevel\": {\n \"_id\": \"<string>\",\n \"level\": 123,\n \"name\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"_id": "<string>"
}Logbuch
Send Note
Send a new note message to a chat.
POST
/
chat
/
v2
/
{id}
/
sendNote
Send a note message
curl --request POST \
--url http://localhost:3000/v2/chat/v2/{id}/sendNote \
--header 'Content-Type: application/json' \
--header 'x-API-Key: <api-key>' \
--data '
{
"_id": "<string>",
"number": 123,
"companyId": "<string>",
"status": {
"status": 123,
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"lastModifiedAt": "2023-11-07T05:31:56Z",
"lastModifiedBy": "<string>"
},
"chatId": "<string>",
"blocks": [
{}
],
"childMessageIds": [
"<string>"
],
"readByUserIds": [
"<string>"
],
"metadata": {
"type": "<string>",
"subId": "<string>",
"date": "2023-11-07T05:31:56Z",
"initialTab": "<string>"
},
"accessLevel": {
"_id": "<string>",
"level": 123,
"name": "<string>"
}
}
'import requests
url = "http://localhost:3000/v2/chat/v2/{id}/sendNote"
payload = {
"_id": "<string>",
"number": 123,
"companyId": "<string>",
"status": {
"status": 123,
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"lastModifiedAt": "2023-11-07T05:31:56Z",
"lastModifiedBy": "<string>"
},
"chatId": "<string>",
"blocks": [{}],
"childMessageIds": ["<string>"],
"readByUserIds": ["<string>"],
"metadata": {
"type": "<string>",
"subId": "<string>",
"date": "2023-11-07T05:31:56Z",
"initialTab": "<string>"
},
"accessLevel": {
"_id": "<string>",
"level": 123,
"name": "<string>"
}
}
headers = {
"x-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
_id: '<string>',
number: 123,
companyId: '<string>',
status: {
status: 123,
createdAt: '2023-11-07T05:31:56Z',
createdBy: '<string>',
lastModifiedAt: '2023-11-07T05:31:56Z',
lastModifiedBy: '<string>'
},
chatId: '<string>',
blocks: [{}],
childMessageIds: ['<string>'],
readByUserIds: ['<string>'],
metadata: {
type: '<string>',
subId: '<string>',
date: '2023-11-07T05:31:56Z',
initialTab: '<string>'
},
accessLevel: {_id: '<string>', level: 123, name: '<string>'}
})
};
fetch('http://localhost:3000/v2/chat/v2/{id}/sendNote', 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 => "3000",
CURLOPT_URL => "http://localhost:3000/v2/chat/v2/{id}/sendNote",
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([
'_id' => '<string>',
'number' => 123,
'companyId' => '<string>',
'status' => [
'status' => 123,
'createdAt' => '2023-11-07T05:31:56Z',
'createdBy' => '<string>',
'lastModifiedAt' => '2023-11-07T05:31:56Z',
'lastModifiedBy' => '<string>'
],
'chatId' => '<string>',
'blocks' => [
[
]
],
'childMessageIds' => [
'<string>'
],
'readByUserIds' => [
'<string>'
],
'metadata' => [
'type' => '<string>',
'subId' => '<string>',
'date' => '2023-11-07T05:31:56Z',
'initialTab' => '<string>'
],
'accessLevel' => [
'_id' => '<string>',
'level' => 123,
'name' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-API-Key: <api-key>"
],
]);
$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:3000/v2/chat/v2/{id}/sendNote"
payload := strings.NewReader("{\n \"_id\": \"<string>\",\n \"number\": 123,\n \"companyId\": \"<string>\",\n \"status\": {\n \"status\": 123,\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"createdBy\": \"<string>\",\n \"lastModifiedAt\": \"2023-11-07T05:31:56Z\",\n \"lastModifiedBy\": \"<string>\"\n },\n \"chatId\": \"<string>\",\n \"blocks\": [\n {}\n ],\n \"childMessageIds\": [\n \"<string>\"\n ],\n \"readByUserIds\": [\n \"<string>\"\n ],\n \"metadata\": {\n \"type\": \"<string>\",\n \"subId\": \"<string>\",\n \"date\": \"2023-11-07T05:31:56Z\",\n \"initialTab\": \"<string>\"\n },\n \"accessLevel\": {\n \"_id\": \"<string>\",\n \"level\": 123,\n \"name\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-API-Key", "<api-key>")
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:3000/v2/chat/v2/{id}/sendNote")
.header("x-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"_id\": \"<string>\",\n \"number\": 123,\n \"companyId\": \"<string>\",\n \"status\": {\n \"status\": 123,\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"createdBy\": \"<string>\",\n \"lastModifiedAt\": \"2023-11-07T05:31:56Z\",\n \"lastModifiedBy\": \"<string>\"\n },\n \"chatId\": \"<string>\",\n \"blocks\": [\n {}\n ],\n \"childMessageIds\": [\n \"<string>\"\n ],\n \"readByUserIds\": [\n \"<string>\"\n ],\n \"metadata\": {\n \"type\": \"<string>\",\n \"subId\": \"<string>\",\n \"date\": \"2023-11-07T05:31:56Z\",\n \"initialTab\": \"<string>\"\n },\n \"accessLevel\": {\n \"_id\": \"<string>\",\n \"level\": 123,\n \"name\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/v2/chat/v2/{id}/sendNote")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["x-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"_id\": \"<string>\",\n \"number\": 123,\n \"companyId\": \"<string>\",\n \"status\": {\n \"status\": 123,\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"createdBy\": \"<string>\",\n \"lastModifiedAt\": \"2023-11-07T05:31:56Z\",\n \"lastModifiedBy\": \"<string>\"\n },\n \"chatId\": \"<string>\",\n \"blocks\": [\n {}\n ],\n \"childMessageIds\": [\n \"<string>\"\n ],\n \"readByUserIds\": [\n \"<string>\"\n ],\n \"metadata\": {\n \"type\": \"<string>\",\n \"subId\": \"<string>\",\n \"date\": \"2023-11-07T05:31:56Z\",\n \"initialTab\": \"<string>\"\n },\n \"accessLevel\": {\n \"_id\": \"<string>\",\n \"level\": 123,\n \"name\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"_id": "<string>"
}Authorizations
API-KeyBearer-Auth
Path Parameters
Chat ID
Body
application/json
Base message structure for chat, note, activity, and email messages.
Unique identifier of the entity
Unique number of the entity, used for identification
The ID of the company this entity belongs to
Entity Status information
Show child attributes
Show child attributes
The type of the message, e.g. chat, activity, email, or note.
Available options:
CHAT_MESSAGE, ACTIVITY_MESSAGE, EMAIL_MESSAGE, NOTE_MESSAGE The ID of the chat this message belongs to.
The blocks that make up the content of the message.
IDs of child messages for threading.
IDs of users who have read this message.
Metadata for the message, such as reference IDs or additional information.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
Note message sent
Was this page helpful?
⌘I