Last modified: August 28, 2025
Run in Postman
Create a note
To create a note, make aPOST
request to /crm/v3/objects/notes
.
In the request body, add note details in a properties object. You can also add an associations object to associate your new note with an existing record (e.g., contacts, companies).
Properties
In the properties object, you can include the following fields:Field | Description |
---|---|
hs_timestamp | Required. This field marks the note’s time of creation and determines where the note sits on the record timeline. You can use either a Unix timestamp in milliseconds or UTC format. |
hs_note_body | The note’s text content, limited to 65,536 characters. |
hubspot_owner_id | The ID of the owner associated with the note. This field determines the user listed as the note creator on the record timeline in HubSpot. |
hs_attachment_ids | The IDs of the note’s attachments. Multiple attachment IDs are separated by a semi-colon. |
Associations
To create and associate a note with existing records, include an associations object in your request. For example, to create a note and associate it with a company and deal, your request body might look similar to the following:Field | Description |
---|---|
to | The record you want to associate with the note, specified by its unique id value. |
types | The type of the association between the note and the record. Include the associationCategory and associationTypeId . Default association type IDs are listed here, or you can retrieve the value for custom association types (i.e. labels) via the associations API. |
Retrieve notes
You can retrieve notes individually or in batches. To retrieve an individual note, make aGET
request to /crm/v3/objects/notes/{noteId}
.
To request a list of all notes, make a GET
request to /crm/v3/objects/notes
.
For both endpoints, you can include the following query parameters in the request URL:
Parameter | Description |
---|---|
properties | A comma separated list of the properties to be returned in the response. If a requested property isn’t defined, it won’t be included in the response. If a requested property is defined but a note doesn’t have a value, it will be returned as null . |
associations | A comma separated list of object types to retrieve associated IDs for. Any specified associations that don’t exist will not be returned in the response. Learn more about the associations API. |
https://api.hubapi.com/crm/v3/objects/notes?limit=10&properties=hs_note_body&associations=contact&archived=false
.
Learn more about retrieving a batch of notes by internal ID or unique property value in the reference documentation.
Update notes
You can update notes individually or in batches. To update an individual note by its note ID, make aPATCH
request to /crm/v3/objects/notes/{noteId}
.
In the request body, include the note properties that you want to update:
Associate existing notes with records
To associate a note with other CRM records, such as a contact, make aPUT
request to /crm/v3/objects/notes/{noteId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}
. The request URL contains the following fields:
Field | Description |
---|---|
noteId | The ID of the note. |
toObjectType | The type of object that you want to associate the note with (e.g., contact or company) |
toObjectId | The ID of the record that you want to associate the note with. |
associationTypeId | A unique identifier to indicate the association type between the note and the other object. The ID can be represented numerically or in snake case (e.g., note_to_contact ). You can retrieve the value through the associations API. |
https://api.hubspot.com/crm/v3/objects/notes/17147287858/associations/contact/581751/202
Remove an association
To remove an association between a note and a record, make aDELETE
request to the same URL as above:
/crm/v3/objects/notes/{noteId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}
Pin a note on a record
You can pin a note on a record so it remains on the top of the record’s timeline. The note must already be associated with the record prior to pinning, and you an only pin one activity per record. To pin a note, include the note’sid
in the hs_pinned_engagement_id
field when creating or updating a record via the object APIs. Learn more about using the companies,contacts, deals, tickets, and custom objects APIs.
Delete notes
You can delete notes individually or in batches, which will add the note to the recycling bin in HubSpot. You can later restore the note from the record timeline. To delete an individual note by its note ID, make aDELETE
request to /crm/v3/objects/notes/{noteId}
.
Learn more about deleting notes in the reference documentation.