Create a new contact note
curl --request POST \
--url https://your-instance.example.com/api/contact-notes \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"contactId": "65c2d0e0f0a0b0c0d0e0f0a0",
"note": "@alice please review the W2 attached.",
"mentions": [
"65b1f0a2c3d4e5f6a7b8c9d0"
],
"attachments": [
{
"key": "orgs/65a0.../notes/w2.pdf",
"name": "w2.pdf",
"size": 121200,
"type": "application/pdf"
}
]
}
'import requests
url = "https://your-instance.example.com/api/contact-notes"
payload = {
"contactId": "65c2d0e0f0a0b0c0d0e0f0a0",
"note": "@alice please review the W2 attached.",
"mentions": ["65b1f0a2c3d4e5f6a7b8c9d0"],
"attachments": [
{
"key": "orgs/65a0.../notes/w2.pdf",
"name": "w2.pdf",
"size": 121200,
"type": "application/pdf"
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
contactId: '65c2d0e0f0a0b0c0d0e0f0a0',
note: '@alice please review the W2 attached.',
mentions: ['65b1f0a2c3d4e5f6a7b8c9d0'],
attachments: [
{
key: 'orgs/65a0.../notes/w2.pdf',
name: 'w2.pdf',
size: 121200,
type: 'application/pdf'
}
]
})
};
fetch('https://your-instance.example.com/api/contact-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://your-instance.example.com/api/contact-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([
'contactId' => '65c2d0e0f0a0b0c0d0e0f0a0',
'note' => '@alice please review the W2 attached.',
'mentions' => [
'65b1f0a2c3d4e5f6a7b8c9d0'
],
'attachments' => [
[
'key' => 'orgs/65a0.../notes/w2.pdf',
'name' => 'w2.pdf',
'size' => 121200,
'type' => 'application/pdf'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://your-instance.example.com/api/contact-notes"
payload := strings.NewReader("{\n \"contactId\": \"65c2d0e0f0a0b0c0d0e0f0a0\",\n \"note\": \"@alice please review the W2 attached.\",\n \"mentions\": [\n \"65b1f0a2c3d4e5f6a7b8c9d0\"\n ],\n \"attachments\": [\n {\n \"key\": \"orgs/65a0.../notes/w2.pdf\",\n \"name\": \"w2.pdf\",\n \"size\": 121200,\n \"type\": \"application/pdf\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://your-instance.example.com/api/contact-notes")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"contactId\": \"65c2d0e0f0a0b0c0d0e0f0a0\",\n \"note\": \"@alice please review the W2 attached.\",\n \"mentions\": [\n \"65b1f0a2c3d4e5f6a7b8c9d0\"\n ],\n \"attachments\": [\n {\n \"key\": \"orgs/65a0.../notes/w2.pdf\",\n \"name\": \"w2.pdf\",\n \"size\": 121200,\n \"type\": \"application/pdf\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://your-instance.example.com/api/contact-notes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"contactId\": \"65c2d0e0f0a0b0c0d0e0f0a0\",\n \"note\": \"@alice please review the W2 attached.\",\n \"mentions\": [\n \"65b1f0a2c3d4e5f6a7b8c9d0\"\n ],\n \"attachments\": [\n {\n \"key\": \"orgs/65a0.../notes/w2.pdf\",\n \"name\": \"w2.pdf\",\n \"size\": 121200,\n \"type\": \"application/pdf\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Contact note created",
"data": {
"_id": "67f0a0b0c0d0e0f0a0b0c0d0",
"userId": {
"_id": "65b1f0a2c3d4e5f6a7b8c9d3",
"fullName": "Cory Tan",
"email": "cory@example.com"
},
"note": "Spoke briefly; will follow up tomorrow.",
"attachments": [],
"reactions": [],
"isEdited": false,
"createdAt": "2026-05-18T14:00:00.000Z"
}
}{
"success": false,
"message": "Contact note not found",
"error": "NOT_FOUND"
}{
"success": false,
"message": "Contact note not found",
"error": "NOT_FOUND"
}{
"success": false,
"message": "Contact note not found",
"error": "NOT_FOUND"
}Contact Notes
Create a new contact note
Create a note on a contact. mentions triggers @-mention notifications to the listed userIds. attachments accepts R2 keys returned from POST /api/upload.
POST
/
api
/
contact-notes
Create a new contact note
curl --request POST \
--url https://your-instance.example.com/api/contact-notes \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"contactId": "65c2d0e0f0a0b0c0d0e0f0a0",
"note": "@alice please review the W2 attached.",
"mentions": [
"65b1f0a2c3d4e5f6a7b8c9d0"
],
"attachments": [
{
"key": "orgs/65a0.../notes/w2.pdf",
"name": "w2.pdf",
"size": 121200,
"type": "application/pdf"
}
]
}
'import requests
url = "https://your-instance.example.com/api/contact-notes"
payload = {
"contactId": "65c2d0e0f0a0b0c0d0e0f0a0",
"note": "@alice please review the W2 attached.",
"mentions": ["65b1f0a2c3d4e5f6a7b8c9d0"],
"attachments": [
{
"key": "orgs/65a0.../notes/w2.pdf",
"name": "w2.pdf",
"size": 121200,
"type": "application/pdf"
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
contactId: '65c2d0e0f0a0b0c0d0e0f0a0',
note: '@alice please review the W2 attached.',
mentions: ['65b1f0a2c3d4e5f6a7b8c9d0'],
attachments: [
{
key: 'orgs/65a0.../notes/w2.pdf',
name: 'w2.pdf',
size: 121200,
type: 'application/pdf'
}
]
})
};
fetch('https://your-instance.example.com/api/contact-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://your-instance.example.com/api/contact-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([
'contactId' => '65c2d0e0f0a0b0c0d0e0f0a0',
'note' => '@alice please review the W2 attached.',
'mentions' => [
'65b1f0a2c3d4e5f6a7b8c9d0'
],
'attachments' => [
[
'key' => 'orgs/65a0.../notes/w2.pdf',
'name' => 'w2.pdf',
'size' => 121200,
'type' => 'application/pdf'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://your-instance.example.com/api/contact-notes"
payload := strings.NewReader("{\n \"contactId\": \"65c2d0e0f0a0b0c0d0e0f0a0\",\n \"note\": \"@alice please review the W2 attached.\",\n \"mentions\": [\n \"65b1f0a2c3d4e5f6a7b8c9d0\"\n ],\n \"attachments\": [\n {\n \"key\": \"orgs/65a0.../notes/w2.pdf\",\n \"name\": \"w2.pdf\",\n \"size\": 121200,\n \"type\": \"application/pdf\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://your-instance.example.com/api/contact-notes")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"contactId\": \"65c2d0e0f0a0b0c0d0e0f0a0\",\n \"note\": \"@alice please review the W2 attached.\",\n \"mentions\": [\n \"65b1f0a2c3d4e5f6a7b8c9d0\"\n ],\n \"attachments\": [\n {\n \"key\": \"orgs/65a0.../notes/w2.pdf\",\n \"name\": \"w2.pdf\",\n \"size\": 121200,\n \"type\": \"application/pdf\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://your-instance.example.com/api/contact-notes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"contactId\": \"65c2d0e0f0a0b0c0d0e0f0a0\",\n \"note\": \"@alice please review the W2 attached.\",\n \"mentions\": [\n \"65b1f0a2c3d4e5f6a7b8c9d0\"\n ],\n \"attachments\": [\n {\n \"key\": \"orgs/65a0.../notes/w2.pdf\",\n \"name\": \"w2.pdf\",\n \"size\": 121200,\n \"type\": \"application/pdf\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Contact note created",
"data": {
"_id": "67f0a0b0c0d0e0f0a0b0c0d0",
"userId": {
"_id": "65b1f0a2c3d4e5f6a7b8c9d3",
"fullName": "Cory Tan",
"email": "cory@example.com"
},
"note": "Spoke briefly; will follow up tomorrow.",
"attachments": [],
"reactions": [],
"isEdited": false,
"createdAt": "2026-05-18T14:00:00.000Z"
}
}{
"success": false,
"message": "Contact note not found",
"error": "NOT_FOUND"
}{
"success": false,
"message": "Contact note not found",
"error": "NOT_FOUND"
}{
"success": false,
"message": "Contact note not found",
"error": "NOT_FOUND"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Contact _id the note is attached to.
Markdown/plain-text body of the note; may contain @-mention syntax.
User _ids @-mentioned in the note; trigger notification pings.
R2 storage keys + content metadata for files attached to the note.
Show child attributes
Show child attributes
Response
Contact note created
Available options:
true Populated note row. userId is populated to the user document (see ContactNoteAuthor).
Show child attributes
Show child attributes
Example:
{
"_id": "67f0a0b0c0d0e0f0a0b0c0d0",
"userId": {
"_id": "65b1f0a2c3d4e5f6a7b8c9d3",
"fullName": "Cory Tan",
"email": "cory@example.com"
},
"note": "@alice please review the W2 attached.",
"attachments": [
{
"name": "w2.pdf",
"size": 121200,
"type": "application/pdf",
"signedUrl": "https://r2.example.com/orgs/65a0.../notes/w2.pdf?token=..."
}
],
"reactions": [
{
"emoji": "👍",
"users": ["65b1f0a2c3d4e5f6a7b8c9d0"],
"count": 1
}
],
"isEdited": false,
"createdAt": "2026-05-18T14:00:00.000Z"
}
⌘I