Create conversation note
curl --request POST \
--url https://api.withallo.com/v2/api/conversations/{contact_number}/notes \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"content": "Escalate to @[Jane Doe](usr-abc123) tomorrow",
"allo_number": "+14155550100"
}
'import requests
url = "https://api.withallo.com/v2/api/conversations/{contact_number}/notes"
payload = {
"content": "Escalate to @[Jane Doe](usr-abc123) tomorrow",
"allo_number": "+14155550100"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
content: 'Escalate to @[Jane Doe](usr-abc123) tomorrow',
allo_number: '+14155550100'
})
};
fetch('https://api.withallo.com/v2/api/conversations/{contact_number}/notes', 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.withallo.com/v2/api/conversations/{contact_number}/notes",
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([
'content' => 'Escalate to @[Jane Doe](usr-abc123) tomorrow',
'allo_number' => '+14155550100'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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.withallo.com/v2/api/conversations/{contact_number}/notes"
payload := strings.NewReader("{\n \"content\": \"Escalate to @[Jane Doe](usr-abc123) tomorrow\",\n \"allo_number\": \"+14155550100\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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("https://api.withallo.com/v2/api/conversations/{contact_number}/notes")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"content\": \"Escalate to @[Jane Doe](usr-abc123) tomorrow\",\n \"allo_number\": \"+14155550100\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.withallo.com/v2/api/conversations/{contact_number}/notes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"content\": \"Escalate to @[Jane Doe](usr-abc123) tomorrow\",\n \"allo_number\": \"+14155550100\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "not-2NyMabc123",
"content": "Escalate to @[Jane Doe](usr-abc123) tomorrow",
"contact_number": "+14155551234",
"allo_number": "+14155550100",
"user": {
"id": "usr-def456",
"name": "John Smith"
},
"mentions": [
{
"user_id": "usr-abc123",
"name": "Jane Doe",
"deleted": false
}
],
"created_at": "2026-07-13T10:00:00",
"updated_at": "2026-07-13T10:00:00"
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}Notes
Créer une note de conversation
Adds an internal team note to a conversation. Notes are never visible to the contact.
POST
/
v2
/
api
/
conversations
/
{contact_number}
/
notes
Create conversation note
curl --request POST \
--url https://api.withallo.com/v2/api/conversations/{contact_number}/notes \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"content": "Escalate to @[Jane Doe](usr-abc123) tomorrow",
"allo_number": "+14155550100"
}
'import requests
url = "https://api.withallo.com/v2/api/conversations/{contact_number}/notes"
payload = {
"content": "Escalate to @[Jane Doe](usr-abc123) tomorrow",
"allo_number": "+14155550100"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
content: 'Escalate to @[Jane Doe](usr-abc123) tomorrow',
allo_number: '+14155550100'
})
};
fetch('https://api.withallo.com/v2/api/conversations/{contact_number}/notes', 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.withallo.com/v2/api/conversations/{contact_number}/notes",
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([
'content' => 'Escalate to @[Jane Doe](usr-abc123) tomorrow',
'allo_number' => '+14155550100'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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.withallo.com/v2/api/conversations/{contact_number}/notes"
payload := strings.NewReader("{\n \"content\": \"Escalate to @[Jane Doe](usr-abc123) tomorrow\",\n \"allo_number\": \"+14155550100\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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("https://api.withallo.com/v2/api/conversations/{contact_number}/notes")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"content\": \"Escalate to @[Jane Doe](usr-abc123) tomorrow\",\n \"allo_number\": \"+14155550100\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.withallo.com/v2/api/conversations/{contact_number}/notes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"content\": \"Escalate to @[Jane Doe](usr-abc123) tomorrow\",\n \"allo_number\": \"+14155550100\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "not-2NyMabc123",
"content": "Escalate to @[Jane Doe](usr-abc123) tomorrow",
"contact_number": "+14155551234",
"allo_number": "+14155550100",
"user": {
"id": "usr-def456",
"name": "John Smith"
},
"mentions": [
{
"user_id": "usr-abc123",
"name": "Jane Doe",
"deleted": false
}
],
"created_at": "2026-07-13T10:00:00",
"updated_at": "2026-07-13T10:00:00"
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}Scope requis :
NOTES_WRITEComportement
Ajoute une note interne d’équipe à la conversation aveccontact_number. Les notes ne sont jamais visibles par le contact.
Identifiez la ligne à laquelle la conversation est rattachée avec allo_number (E.164, listez vos lignes avec GET /v2/api/numbers) ou sender_id (pour les conversations d’une boîte sender ID). Omettre les deux retourne une erreur 400 avec le code MISSING_ALLO_NUMBER_OR_SENDER_ID.
Mentions
Mentionnez des coéquipiers inline danscontent avec @[Display Name](usr-xxxx) — ils reçoivent les mêmes notifications push, email et in-app que les mentions faites depuis les applications Allo. Voir le guide des mentions.
Erreurs
| Statut | Code | Quand |
|---|---|---|
400 | EMPTY_NOTE_CONTENT | content est manquant ou vide |
400 | NOTE_CONTENT_TOO_LONG | content dépasse 4 000 caractères |
400 | MISSING_ALLO_NUMBER_OR_SENDER_ID | Ni allo_number ni sender_id n’a été fourni |
403 | ALLO_NUMBER_FORBIDDEN | Vous n’avez pas accès à cette ligne Allo |
404 | SENDER_ID_NOT_FOUND | Aucun sender ID avec cet identifiant sur votre compte |
Autorisations
Paramètres de chemin
The contact's phone number (E.164)
Exemple:
"+14155551234"
Corps
application/json
Note text (max 4000 characters). Mention teammates inline with @[Name](usr-...), or @[all](all) to notify the whole team.
Exemple:
"Escalate to @[Jane Doe](usr-abc123) tomorrow"
The Allo line the conversation belongs to (E.164). Required unless sender_id is provided.
Exemple:
"+14155550100"
Sender-ID inbox identifier, as an alternative to allo_number for sender-ID conversations.
Réponse
Note created
Show child attributes
Show child attributes
Cette page vous a-t-elle été utile ?