Skip to main content
POST

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request body for creating a note attached directly to one or more entities. At least one of persons, companies, or opportunities must include an entry, since a note of this type requires at least one attached entity.

type
string
required

The note type. Must be entities to create a note attached to only entities.

Allowed value: "entities"
content
notes.ContentToBeSaved · object
required

The note's body content. Only html is supported on write; supply rendered HTML limited to the allowed tags listed below.

creator
PersonReference · object

The person to record as the note's creator. Defaults to the calling user when omitted, and must reference an active internal person in your organization.

createdAt
string<date-time>

The time to record as when the note was created. Set this to backfill historical notes with their original date. Defaults to the current time when omitted.

Example:

"2025-01-15T09:30:00Z"

persons
PersonReference · object[]

Persons to attach the note to. Each item references a Person by id.

Maximum array length: 100
Example:
companies
CompanyReference · object[]

Companies to attach the note to. Each item references a Company by id.

Maximum array length: 100
Example:
opportunities
OpportunityReference · object[]

Opportunities to attach the note to. Each item references an Opportunity by id.

Maximum array length: 100
Example:

Response

Created

A Note object attached to an entity (Person, Company, Opportunity)

id
integer<int32>
required

The id of the note

Required range: 1 <= x <= 2147483647
content
notes.Content · object
required

A note content

creator
PersonData · object
required
mentions
notes.Mention · object[]
required

The mentions in the note

Maximum array length: 100
createdAt
string<date-time>
required

The date and time the note was created

updatedAt
string<date-time> | null
required

The date and time the note was last updated

type
string
required

The type of the note

Allowed value: "entities"
repliesCount
integer<int32>

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.

Required range: 0 <= x <= 2147483647
opportunitiesPreview
notes.OpportunitiesPreview · object

A preview for Opportunities directly attached to the Note

personsPreview
notes.PersonsPreview · object

A preview for Persons directly attached to the Note

companiesPreview
notes.CompaniesPreview · object

A preview for Companies directly attached to the Note