curl --request POST \
  --url https://api.affinity.co/v2/notes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "entities",
  "content": {
    "html": "<p>Followed up after the demo. Strong interest, will recirculate next week.</p>"
  },
  "persons": [
    {
      "id": 2
    },
    {
      "id": 3
    }
  ],
  "companies": [
    {
      "id": 10
    }
  ],
  "opportunities": [
    {
      "id": 100
    }
  ]
}
'

{
  "id": 1,
  "type": "entities",
  "content": {
    "html": "<p>Followed up after the demo. Strong interest, will recirculate next week.</p>"
  },
  "creator": {
    "id": 1,
    "firstName": "Jane",
    "lastName": "Smith",
    "primaryEmailAddress": "jane.smith@northpointvc.com",
    "type": "internal"
  },
  "mentions": [],
  "createdAt": "2023-01-01T00:00:00Z",
  "updatedAt": null
}

Notes

Create a Note

⚠️ This endpoint is currently in BETA

Create a new note. By default it is authored by the calling user; set creator to attribute it to a different internal person in your organization. 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 cannot be created 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).	None

By default a note is authored by the calling user. To attribute a note to a different member of your organization, set the optional creator field to reference that person by id. The referenced person must be an active internal person in your organization.

Body content. content.html is rendered HTML that must use only the allowed tags; submitting restricted tags, attributes, URL schemes, or mention spans will cause the request to fail. See the request examples below for representative payloads.

POST

notes

curl --request POST \
  --url https://api.affinity.co/v2/notes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "entities",
  "content": {
    "html": "<p>Followed up after the demo. Strong interest, will recirculate next week.</p>"
  },
  "persons": [
    {
      "id": 2
    },
    {
      "id": 3
    }
  ],
  "companies": [
    {
      "id": 10
    }
  ],
  "opportunities": [
    {
      "id": 100
    }
  ]
}
'

{
  "id": 1,
  "type": "entities",
  "content": {
    "html": "<p>Followed up after the demo. Strong interest, will recirculate next week.</p>"
  },
  "creator": {
    "id": 1,
    "firstName": "Jane",
    "lastName": "Smith",
    "primaryEmailAddress": "jane.smith@northpointvc.com",
    "type": "internal"
  },
  "mentions": [],
  "createdAt": "2023-01-01T00:00:00Z",
  "updatedAt": null
}

Authorizations

Authorization

string

header

required

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

Body

application/json

notes.EntitiesNoteToBeCreated
notes.InteractionNoteToBeCreated
notes.UserReplyNoteToBeCreated

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.

Show child attributes

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.

Show child attributes

persons

PersonReference · object[]

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

Maximum array length: 100

Show child attributes

Example:

[{ "id": 1 }, { "id": 2 }]

companies

CompanyReference · object[]

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

Maximum array length: 100

Show child attributes

Example:

[{ "id": 10 }]

opportunities

OpportunityReference · object[]

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

Maximum array length: 100

Show child attributes

Example:

[{ "id": 100 }]

Response

Created

notes.EntitiesNote
notes.InteractionNote
notes.AiNotetakerRootNote
notes.UserReplyNote
notes.AiNotetakerReplyNote

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

integer<int32>

required

The id of the note

Required range: 1 <= x <= 2147483647

content

notes.Content · object

required

A note content

Show child attributes

creator

PersonData · object

required

Show child attributes

mentions

notes.Mention · object[]

required

The mentions in the note

Maximum array length: 100

Show child attributes

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

Show child attributes

personsPreview

notes.PersonsPreview · object

A preview for Persons directly attached to the Note

Show child attributes

companiesPreview

notes.CompaniesPreview · object

A preview for Companies directly attached to the Note

Show child attributes

Get all Notes Search Notes by Keyword

⌘I