Notes
Create, update, delete, and query Notes that are visible to the authenticated user and related to a specific Person, Company, Case, or Deal.
Table Specific Information
Select
To retrieve Notes, provide a SubjectType that the Note belongs to, such as People, Companies, Cases, or Deals, and the Subject Id.
SELECT * FROM Notes WHERE SubjectType = 'Companies' AND SubjectId = 149760370To retrieve information related to a specific note, provide the Id of the note.
SELECT * FROM Notes WHERE Id = 351922361To retrieve all the notes from all the companies, you can use a subquery with IN operator.
SELECT * FROM Notes WHERE SubjectType = 'Companies' AND SubjectId IN (SELECT Id FROM Companies)
For datetime columns only the '>' and '>=' operators are supported in the WHERE clause.
SELECT * FROM Notes WHERE SubjectType = 'Companies' AND SubjectId = 149760370 AND UpdatedAt > '2012-01-12'
Insert
The Note's Body, Subject Id, and Subject Type are required to create a new Note.
INSERT INTO Notes (Body, SubjectId, SubjectType) VALUES ('my note', 149760370, 'Companies')
Update
To update an existing Note, you must provide its Id.
UPDATE NOTES SET Body = 'updated note' WHERE Id = 499468019
Delete
To delete an existing Note, you must provide its Id.
DELETE FROM NOTES WHERE Id = 499929021
Columns
Name | Type | ReadOnly | References | Description |
Id [KEY] | Integer | True |
The unique identifier of the note. | |
Title | String | True |
The title of the note. | |
Body | String | False |
The body of the note. | |
AuthorId | Integer | True |
The Id of the author of the note. | |
SubjectId | Integer | True |
The Id of the subject of the note. This can be a reference to a person, company, case, or deal. | |
SubjectType | String | True |
The subject type of the note: person, company, case, or deal. | |
SubjectName | String | True |
The subject name of the note. | |
CollectionId | Integer | True |
The Id of the collection associated with the note. | |
CollectionType | String | True |
The type of the collection associated with the note. | |
VisibleTo | String | True |
Who the note is visible to: Everyone, Owner, or NamedGroup. | |
OwnerId | Integer | True |
The Id of the owner associated with the note. | |
GroupId | Integer | True |
The Id of the group associated with the note. | |
CreatedAt | Datetime | True |
The date and time when the note was created. | |
UpdatedAt | Datetime | True |
The date and time when the note was last updated. |