{
"errors": [
{
"code": "bad-request",
"message": "<string>"
}
]
}{
"errors": [
{
"code": "authorization",
"message": "<string>"
}
]
}{
"errors": [
{
"code": "not-found",
"message": "<string>"
}
]
}{
"errors": [
{
"code": "authentication",
"message": "<string>"
}
]
}Update a single Note
Make an update to an existing note’s body content or its entity associations.
You can only update notes you have write access to. You can update any type of note including
AI Notetaker notes (ai-notetaker, ai-notetaker-reply), but a note’s type itself cannot be
changed.
All body properties are optional: only the properties supplied are updated, and other
properties are left unchanged. For each of persons, companies, and opportunities, you
may:
- omit the field to leave existing associations unchanged
- send an empty array (
[]) to clear all associations of that kind - send a non-empty array to replace the existing set with the supplied list.
Reply notes (user-reply, ai-notetaker-reply) have no entity associations, so only
content can be updated for replies.
Updating content is subject to the same HTML restrictions as creation; submitting restricted
HTML will cause the request to fail. See the request examples below.
The content of notes that contain @mentions cannot be updated through this endpoint;
attempting to do so returns 400 Bad Request.
Returns 204 No Content on success, regardless of whether any properties actually changed.
{
"errors": [
{
"code": "bad-request",
"message": "<string>"
}
]
}{
"errors": [
{
"code": "authorization",
"message": "<string>"
}
]
}{
"errors": [
{
"code": "not-found",
"message": "<string>"
}
]
}{
"errors": [
{
"code": "authentication",
"message": "<string>"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The id of the Note to update
1 <= x <= 2147483647Body
Request body for updating an existing note. All properties are optional: only those explicitly provided are updated, and other properties are left unchanged.
The properties that may be updated depend on the existing note's type:
- Root notes (
entities,interaction,ai-notetaker) may updatecontentand the entity association arrays (persons,companies,opportunities). - Reply notes (
user-reply,ai-notetaker-reply) may updatecontentonly; attachingpersons,companies, oropportunitiesto a reply note is rejected.
For each of persons, companies, and opportunities, you may:
- omit the field to leave existing associations unchanged
- send an empty array (
[]) to clear all associations of that kind - send a non-empty array to replace the existing set with the supplied list.
Any note the caller has write access to can be updated, including AI Notetaker notes. A note's type itself cannot be changed. The content of notes that contain @mentions cannot be updated.
If provided, replaces the note's content. Subject to the same HTML restrictions as creation.
Show child attributes
Show child attributes
Persons attached to the note. Each item references a Person by id. Only valid for root notes.
100Show child attributes
Show child attributes
Companies attached to the note. Each item references a Company by id. Only valid for root notes.
100Show child attributes
Show child attributes
Opportunities attached to the note. Each item references an Opportunity by id. Only valid for root notes.
100Show child attributes
Show child attributes
Response
No Content
Was this page helpful?