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 cmdlet 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 cmdlet 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 cmdlet.
- 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 | False |
The unique identifier for this record. |
NoteOwner_Id | String | False |
The Id of the note owner. |
NoteOwner_FirstName | String | False |
The First Name of the note owner. |
NoteOwner_LastName | String | False |
The Last Name of the note owner. |
NoteTitle | String | False |
The title of the note. |
NoteContent | String | False |
The text content of the note. |
ParentID_Id | String | False |
The Id of the parent of this note. |
CreatedBy_Id | String | False |
The Id of the User who created the record. |
ModifiedBy_Id | String | False |
The Id of the User who modified the record. |
ModifiedBy_FirstName | String | False |
The First Name of the User who modified the record. |
ModifiedBy_LastName | String | False |
The Last Name of the User who modified the record. |
CreatedTime | Datetime | False |
The time when the record was created. |
ModifiedTime | Datetime | False |
The time when the record was modified. |
ModuleName | String | False |
The name of the module this note belongs to. |
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 in an upsert. |
CustomViewId | Long |
The custom view Id to be used for filtering this record. Will work when useCOQL=false. |