Notes
Holds free-form textual notes linked to CRM records, with support for rich text, authorship, and timestamps.
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 driver 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
The driver uses the Zoho CRM API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the driver.
- NoteTitle supports the '=, LIKE' operators.
- NoteContent supports the '=, LIKE' operators.
- CreatedTime supports the '=' operator.
- ModifiedTime supports the '=' operator.
For example, the following queries are processed server side:
SELECT * FROM Notes WHERE Id = '3152079000000153079' SELECT * FROM Notes WHERE NoteTitle = 'Deal details'
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.
Any field which is not read-only (ReadOnly = false in the table below) can be inserted.
Delete
You must specify the Id in the WHERE clause when executing a delete against this table.
DELETE FROM Notes WHERE Id = '3152079000000488014'
Update
You must specify the Id in the WHERE clause when executing an update against this table.
UPDATE Notes SET NoteTitle = 'Changed from the API.' WHERE Id = '3152079000000304003'
Required fields: Id.
Any field which is not read-only (ReadOnly = false in the table below) can be updated.
Columns
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | True |
Unique identifier of the note record. |
| NoteOwner_Id | String | False |
Identifier 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 |
The title or subject line of the note. |
| NoteContent | String | False |
The main content or body of the note. |
| ParentID_Id | String | False |
Identifier of the parent record that this note is associated with. |
| ParentID_Name | String | True |
Name of the parent record that this note is associated with. |
| CreatedBy_Id | String | False |
Identifier 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 |
Identifier 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. |
| Associated_Id | Long | False |
Identifier of the related entity associated with the note. |
| ModuleName | String | False |
Name of the module to which this note belongs. |
| Attachments | String | False |
List of attachments linked 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 |
State or status of the note record. |
| VoiceNote | String | False |
Information about any associated voice note. |
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 fields to be used for checking duplicate records during upsert operations. The REST API supports multiple fields while the BULK API supports only one. |
| Trigger | String |
Specifies whether to trigger automation rules while inserting this note into the CRM account. |
| CustomViewId | Long |
The custom view identifier used to filter this note record. Only works when the useCOQL parameter is set to false. |