Create a Note
| ⚠️ This endpoint is currently in BETA |
|---|
Create a new note authored by the calling user. Notes can be attached directly to entities (Persons, Companies, Opportunities), anchored to an interaction (meeting, call, or chat message), or written as a reply to an existing note.
The type field selects the shape of the request body. AI Notetaker note types
(ai-notetaker, ai-notetaker-reply) are system-generated and are not creatable through
this endpoint.
type | Description | Required | Optional |
|---|---|---|---|
entities | A note attached directly to one or more entities. | content, and at least one of persons / companies / opportunities. | Any combination of persons / companies / opportunities. |
interaction | A note anchored to a meeting, call, or chat message. | content, interaction.{type,id}. | persons / companies / opportunities — added as direct associations on top of the interaction’s own participants. |
user-reply | A reply to an existing root note. Replies have no entity associations or interaction attachment of their own. | content, parent.id (must reference an existing root note the caller can access). | — |
Body content. content.html is rendered HTML that must conform to the restricted tag set
documented on notes.ContentToBeSaved; submitting disallowed tags, attributes, URL schemes,
or mention spans will cause the request to fail. See the request examples below for
representative payloads.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
- notes.EntitiesNoteToBeCreated
- notes.InteractionNoteToBeCreated
- notes.UserReplyNoteToBeCreated
Request body for creating a note attached directly to one or more entities (Persons, Companies, and/or Opportunities). At least one of persons, companies, or opportunities must contain at least one entry — a note of this type cannot exist without at least one attached entity.
Discriminator. Must be entities to create a note attached to only entities.
"entities"The note's body content. Only html is supported on write; supply rendered HTML that uses the restricted tag set listed below.
Persons to attach the note to. Each item references a Person by id. May be combined with companies and/or opportunities.
100[{ "id": 1 }, { "id": 2 }]Companies to attach the note to. Each item references a Company by id. May be combined with persons and/or opportunities.
100[{ "id": 10 }]Opportunities to attach the note to. Each item references an Opportunity by id. May be combined with persons and/or companies.
100[{ "id": 100 }]Response
Created
- notes.EntitiesNote
- notes.InteractionNote
- notes.AiNotetakerRootNote
- notes.UserReplyNote
- notes.AiNotetakerReplyNote
A Note object attached to an entity (Person, Company, Opportunity)
The id of the note
1 <= x <= 2147483647A note content
The mentions in the note
100The date and time the note was created
The date and time the note was last updated
The type of the note
"entities"The number of replies to this note. This is only included if the repliesCount parameter is passed in the includes in the request and the note is not a reply itself.
0 <= x <= 2147483647A preview for Opportunities directly attached to the Note
A preview for Persons directly attached to the Note
A preview for Companies directly attached to the Note