Contact records store information about individuals. The contacts endpoints allow you to manage this data and sync it between HubSpot and other systems.
POST
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).
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. |
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. |
GET
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.
PATCH
request to /crm/v3/objects/notes/{noteId}
.
In the request body, include the note properties that you want to update:
PUT
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
DELETE
request to the same URL as above:
/crm/v3/objects/notes/{noteId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}
id
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
request to /crm/v3/objects/notes/{noteId}
.
Learn more about deleting notes in the reference documentation.