Skip to main content
POST
/
v2
/
notes
/
{noteId}
curl --request POST \
  --url https://api.affinity.co/v2/notes/{noteId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "content": {
    "html": "<p>Updated recap: pricing approved, contract going out today.</p>"
  }
}
'
{
  "errors": [
    {
      "code": "bad-request",
      "message": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
noteId
integer<int32>
required

The id of the Note to update

Required range: 1 <= x <= 2147483647

Body

application/json

Request body for updating an existing note. All properties are optional - only those explicitly provided are mutated; omitted properties are left unchanged.

The properties that may be updated depend on the existing note's type:

  • Root notes (entities, interaction, ai-notetaker) may update content and the entity association arrays (persons, companies, opportunities).
  • Reply notes (user-reply, ai-notetaker-reply) may update content only; attaching persons, companies, or opportunities to 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, or
  • send a non-empty array to replace the existing set with the supplied list.

Any note the caller has write access to is updatable, including AI Notetaker notes. A note's type itself cannot be changed. The content of notes that contain @mentions cannot be updated.

​
content
notes.ContentToBeSaved · object

If provided, replaces the note's content. Subject to the same HTML restrictions as creation (see notes.ContentToBeSaved).

​
persons
PersonReference · object[]

Persons attached to the note. When replacing, each item references a Person by id. Only valid for root notes.

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

Companies attached to the note. When replacing, each item references a Company by id. Only valid for root notes.

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

Opportunities attached to the note. When replacing, each item references an Opportunity by id. Only valid for root notes.

Maximum array length: 100

Response

No Content