Notes
Create, update, delete, and query information regarding notes.
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 server 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 |
Id |
| NoteOwner_Id | String | False |
NoteOwner Id |
| NoteOwner_FirstName | String | True |
NoteOwner FirstName |
| NoteOwner_LastName | String | True |
NoteOwner LastName |
| NoteOwner_Email | String | True |
NoteOwner Email |
| NoteOwner_Name | String | True |
NoteOwner Name |
| NoteTitle | String | False |
NoteTitle |
| NoteContent | String | False |
NoteContent |
| ParentID_Id | String | False |
ParentID Id |
| ParentID_Name | String | True |
ParentID Name |
| CreatedBy_Id | String | False |
CreatedBy Id |
| CreatedBy_FirstName | String | True |
CreatedBy FirstName |
| CreatedBy_LastName | String | True |
CreatedBy LastName |
| CreatedBy_Email | String | True |
CreatedBy Email |
| CreatedBy_Name | String | True |
CreatedBy Name |
| ModifiedBy_Id | String | False |
ModifiedBy Id |
| ModifiedBy_FirstName | String | True |
ModifiedBy FirstName |
| ModifiedBy_LastName | String | True |
ModifiedBy LastName |
| ModifiedBy_Email | String | True |
ModifiedBy Email |
| ModifiedBy_Name | String | True |
ModifiedBy Name |
| CreatedTime | Datetime | False |
CreatedTime |
| ModifiedTime | Datetime | False |
ModifiedTime |
| RecordId | Long | True |
RecordId |
| Associated_Id | Long | False |
Associated_Id |
| ModuleName | String | False |
ModuleName |
| Attachments | String | False |
Attachments |
| Editable | String | False |
Editable |
| IsSharedToClient | String | False |
IsSharedToClient |
| State | String | False |
State |
| VoiceNote | String | False |
VoiceNote |
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 |
The field(s) to be used for checking duplicate records in an upsert. The REST API allows for more than one field in the duplicate check but the BULK API only allows one field. |
| Trigger | String |
To trigger the rule while inserting record into CRM account. |
| CustomViewId | Long |
The custom view Id to be used for filtering this record. Will work when useCOQL=false. |