Update a contact note
curl --request PATCH \
--url https://your-instance.example.com/api/contact-notes/{noteId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"note": "@alice please review the W2 attached. Updated copy."
}
'import requests
url = "https://your-instance.example.com/api/contact-notes/{noteId}"
payload = { "note": "@alice please review the W2 attached. Updated copy." }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({note: '@alice please review the W2 attached. Updated copy.'})
};
fetch('https://your-instance.example.com/api/contact-notes/{noteId}', 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/{noteId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'note' => '@alice please review the W2 attached. Updated copy.'
]),
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/{noteId}"
payload := strings.NewReader("{\n \"note\": \"@alice please review the W2 attached. Updated copy.\"\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://your-instance.example.com/api/contact-notes/{noteId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"note\": \"@alice please review the W2 attached. Updated copy.\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://your-instance.example.com/api/contact-notes/{noteId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"note\": \"@alice please review the W2 attached. Updated copy.\"\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
Update a contact note
Edit a note’s body or attachments. Only the note’s author may edit; updating flips isEdited to true.
PATCH
/
api
/
contact-notes
/
{noteId}
Update a contact note
curl --request PATCH \
--url https://your-instance.example.com/api/contact-notes/{noteId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"note": "@alice please review the W2 attached. Updated copy."
}
'import requests
url = "https://your-instance.example.com/api/contact-notes/{noteId}"
payload = { "note": "@alice please review the W2 attached. Updated copy." }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({note: '@alice please review the W2 attached. Updated copy.'})
};
fetch('https://your-instance.example.com/api/contact-notes/{noteId}', 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/{noteId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'note' => '@alice please review the W2 attached. Updated copy.'
]),
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/{noteId}"
payload := strings.NewReader("{\n \"note\": \"@alice please review the W2 attached. Updated copy.\"\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://your-instance.example.com/api/contact-notes/{noteId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"note\": \"@alice please review the W2 attached. Updated copy.\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://your-instance.example.com/api/contact-notes/{noteId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"note\": \"@alice please review the W2 attached. Updated copy.\"\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.
Path Parameters
Body
application/json
Response
Contact note updated
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