Notes
Holds free-form text notes linked to CRM records, including author, timestamp, and rich-text content.
Table-Specific Information
Note: The Bulk API is not supported by the Notes table. Due to this, if you are using the Bulk API (UseCOQL set to False and APIType set to Bulk), the connector will instead use the REST API (with its associated limitations) when working with notes data. Refer to v2, v2.1, or v4 (in accordance with the value you set for Schema) to see the limits imposed by the REST API.
Select
This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.
SELECT * FROM Notes WHERE Id = '3152079000000153079'
Insert
INSERT INTO Notes (ParentID_Id, ModuleName, NoteContent) VALUES ('3276571000000184007', 'Leads', 'Janet converted this lead.')
Required fields:
- ParentID_Id (the Id of the item in which you are inserting the note to)
- ModuleName (the API name of the module you are inserting the note to)
- NoteContent
You can insert any field which is not read-only (ReadOnly = false in the table below).
Delete
Specify the Id in the WHERE clause when executing a delete in this table.
DELETE FROM Notes WHERE Id = '3152079000000488014'
Update
Specify the Id in the WHERE clause when executing an update in this table.
UPDATE Notes SET NoteTitle = 'Changed from the API.' WHERE Id = '3152079000000304003'
Required fields: Id.
You can update any field which is not read-only (ReadOnly = false in the table below).
Columns
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | True |
Unique identifier of the note. |
| NoteOwner_Id | String | False |
Id of the user who owns the note. |
| NoteOwner_FirstName | String | True |
First name of the user who owns the note. |
| NoteOwner_LastName | String | True |
Last name of the user who owns the note. |
| NoteOwner_Email | String | True |
Email address of the user who owns the note. |
| NoteOwner_Name | String | True |
Full name of the user who owns the note. |
| NoteTitle | String | False |
Title of the note. |
| NoteContent | String | False |
Main content of the note. |
| ParentID_Id | String | False |
Id of the parent record the note is associated with. |
| ParentID_Name | String | True |
Name of the parent record the note is associated with. |
| CreatedBy_Id | String | False |
Id of the user who created the note. |
| CreatedBy_FirstName | String | True |
First name of the user who created the note. |
| CreatedBy_LastName | String | True |
Last name of the user who created the note. |
| CreatedBy_Email | String | True |
Email address of the user who created the note. |
| CreatedBy_Name | String | True |
Full name of the user who created the note. |
| ModifiedBy_Id | String | False |
Id of the user who last modified the note. |
| ModifiedBy_FirstName | String | True |
First name of the user who last modified the note. |
| ModifiedBy_LastName | String | True |
Last name of the user who last modified the note. |
| ModifiedBy_Email | String | True |
Email address of the user who last modified the note. |
| ModifiedBy_Name | String | True |
Full name of the user who last modified the note. |
| CreatedTime | Datetime | False |
Date and time when the note was created. |
| ModifiedTime | Datetime | False |
Date and time when the note was last modified. |
| RecordId | Long | True |
Internal record identifier used for tracking. |
| Associated_Id | Long | False |
Identifier linking the note to another record. |
| ModuleName | String | False |
Name of the module to which the note belongs. |
| Attachments | String | False |
List of files attached to the note. |
| Editable | String | False |
Indicates whether the note can be edited. |
| IsSharedToClient | String | False |
Indicates whether the note is visible to the client. |
| State | String | False |
Status or state of the note. |
| VoiceNote | String | False |
Link or reference to the associated voice note, if any. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| DuplicateCheckFields | String |
Field or fields used to identify duplicates during an upsert operation. The REST API allows multiple fields, while the BULK API allows only one. |
| Trigger | String |
Used to trigger automation rules when inserting a note into the CRM account. |
| CustomViewId | Long |
Custom view identifier used to filter this note. Works only when the useCOQL parameter is set to false. |